14#include "ff_timesig.h"
38 const char*
ClassName()
const override {
return "__FCOther"; }
64#ifndef DOXYGEN_SHOULD_IGNORE_THIS
66 bool LoadFirst()
override {
return false; }
68 bool _RawRelink()
override
80 const char*
ClassName()
const override {
return "__FCInciOther"; }
89 virtual bool Load(CMPER itemno, twobyte inci);
103 virtual bool SaveNew(CMPER itemno);
168 twobyte _inciblock[6];
170 int DataSizeLoad()
const override {
return sizeof(_inciblock); }
171 void* Allocate()
override {
return _GetDataPtr(); }
180 memcpy(&_inciblock, ((
FCOtherInci*)pSource)->_GetDataPtr(),
sizeof(_inciblock));
198 memset(&_inciblock, 0,
sizeof(_inciblock));
204#ifndef DOXYGEN_SHOULD_IGNORE_THIS
211 void* _GetDataPtr() {
return &_inciblock; }
214 const char*
ClassName()
const override {
return "FCOtherInci"; }
233#ifndef DOXYGEN_SHOULD_IGNORE_THIS
241 int _DataSizeLoadFullCmper(CMPER cmper, ETAG othertag)
const;
250 bool _SaveOtherFullCmper(CMPER cmper,
void* buffer,
int size, ETAG othertag);
259 bool _LoadOtherFullCmper(CMPER cmper,
void* buffer,
int size, ETAG othertag);
262 const char*
ClassName()
const override {
return "__FCNoInciOther"; }
271 virtual bool Load(CMPER itemno);
281 virtual bool SaveAs(CMPER itemno);
348#ifdef PDK_FRAMEWORK_DEBUG
365#ifndef DOXYGEN_SHOULD_IGNORE_THIS
368 EDTCompositeTimeUpper _compositetimeupperdata;
371 EXTAG
Tag()
const override {
return ot_CompositeTimeUpper; }
372 int DataSizeLoad()
const override {
return sizeof(EDTCompositeTimeUpper); }
373 void*
Allocate()
override {
return (
void*) &_compositetimeupperdata; }
392 const char*
ClassName()
const override {
return "__FCCompositeTimeSigTopElement"; }
395#ifndef DOXYGEN_SHOULD_IGNORE_THIS
402 void* _GetDataPtr() {
return &_compositetimeupperdata; }
408 memset(&_compositetimeupperdata, 0,
sizeof(_compositetimeupperdata));
420#ifdef PDK_FRAMEWORK_DEBUG
436#ifndef DOXYGEN_SHOULD_IGNORE_THIS
439 EDTCompositeTimeLower _compositetimelowerdata;
442 EXTAG
Tag()
const override {
return ot_CompositeTimeLower; }
443 int DataSizeLoad()
const override {
return sizeof(EDTCompositeTimeLower); }
444 void*
Allocate()
override {
return (
void*) &_compositetimelowerdata; }
463 const char*
ClassName()
const override {
return "__FCCompositeTimeSigBottomElement"; }
466#ifndef DOXYGEN_SHOULD_IGNORE_THIS
473 void* _GetDataPtr() {
return &_compositetimelowerdata; }
479 memset(&_compositetimelowerdata, 0,
sizeof(_compositetimelowerdata));
494#ifdef PDK_FRAMEWORK_DEBUG
504#ifdef PDK_FRAMEWORK_COMPOSITETIMESIGS
518 ECompositeTimeUpper* _pArray;
524#ifndef DOXYGEN_SHOULD_IGNORE_THIS
529 ECompositeTimeUpper* _GetGroupElementPtr(
int groupindex,
int subindex)
const
532 int currentindex = 0;
533 int subindexcount = 0;
534 for (
int i = 0; i < _arraycounter; i++)
536 if (_pArray[i].chainstart) currentindex++;
537 if (currentindex == groupindex)
539 if (subindexcount == subindex)
return &_pArray[i];
542 if (currentindex > groupindex)
return NULL;
554 void _RedistributeArray(CMPER cmper = 0)
560 cmper = pFirstInci->
_GetDataID()->other.cmper;
565 for (
int i = 0; i < _arraycounter; i++)
570 EDataID* pDataID = (EDataID*) pCurrentObject->
_GetDataID();
571 pDataID->other.cmper = cmper;
572 pDataID->other.inci = inci;
574 memcpy(pCurrentObject->
_GetFirstRecordPtr(), &_pArray[i],
sizeof(ECompositeTimeUpper));
580 pCurrentObject = NULL;
583 if (pCurrentObject)
Add(pCurrentObject);
587#ifndef DOXYGEN_SHOULD_IGNORE_THIS
592#ifndef DOXYGEN_SHOULD_IGNORE_THIS
601 int activerecords = 0;
602 for (
int i = 0; i <
GetCount(); i++)
606 if ((pCompositeTimeUpper->main == 0) &&
607 (pCompositeTimeUpper->fraction == 0))
continue;
610 if ((pCompositeTimeUpper->main == 0) &&
611 (pCompositeTimeUpper->fraction == 0))
continue;
614 if (activerecords == 0)
return;
616 _pArray =
new ECompositeTimeUpper[activerecords];
617 int currentindex = 0;
618 for (
int i = 0; i <
GetCount(); i++)
622 if ((pCompositeTimeUpper->main == 0) &&
623 (pCompositeTimeUpper->fraction == 0))
continue;
624 memcpy(&_pArray[currentindex], pCompositeTimeUpper,
sizeof(ECompositeTimeUpper));
627 if ((pCompositeTimeUpper->main == 0) &&
628 (pCompositeTimeUpper->fraction == 0))
continue;
629 memcpy(&_pArray[currentindex], pCompositeTimeUpper,
sizeof(ECompositeTimeUpper));
632 _arraycounter = activerecords;
636 const char*
ClassName()
const override {
return "FCCompositeTimeSigTop"; }
666 for (
int i = 0; i < _arraycounter; i++)
668 if (_pArray[i].chainstart) groupcount++;
683 if (elementcount < 1)
return -1;
684 if (elementcount > 10)
return -1;
686 ECompositeTimeUpper* pNewArray =
new ECompositeTimeUpper[_arraycounter + elementcount];
691 int bytesize =
sizeof(ECompositeTimeUpper) * _arraycounter;
692 memcpy(pNewArray, _pArray, bytesize);
697 ECompositeTimeUpper* pNewAddedData = &pNewArray[_arraycounter];
698 for (
int i = 0; i < elementcount; i++)
700 pNewAddedData->chainstart = (i == 0);
701 pNewAddedData->fraction = 0;
702 pNewAddedData->main = 1;
707 _arraycounter += elementcount;
721 if (groupindex < 1)
return;
722 ECompositeTimeUpper* pData = _GetGroupElementPtr(groupindex, 0);
724 pData->chainstart =
false;
739 int currentindex = 0;
741 for (
int i = 0; i < _arraycounter; i++)
743 if (_pArray[i].chainstart) currentindex++;
744 if (currentindex == index) count++;
745 if (currentindex > index)
return count;
764 for (
int elementidx = 0; elementidx < elementcount; elementidx++)
782 ECompositeTimeUpper* pCompositeTimeUpper = _GetGroupElementPtr(groupindex, subindex);
783 if (!pCompositeTimeUpper)
return 0;
784 return pCompositeTimeUpper->main;
798 ECompositeTimeUpper* pCompositeTimeUpper = _GetGroupElementPtr(groupindex, subindex);
799 if (!pCompositeTimeUpper)
return 0;
800 if (! pCompositeTimeUpper->fraction)
return pCompositeTimeUpper->main;
801 assert(LO_UONEBYTE(pCompositeTimeUpper->fraction) != 0);
802 return static_cast<double>(pCompositeTimeUpper->main) +
803 (
static_cast<double>(HI_UONEBYTE(pCompositeTimeUpper->fraction)) /
static_cast<double>(LO_UONEBYTE(pCompositeTimeUpper->fraction)));
813 return _arraycounter;
826 ECompositeTimeUpper* pCompositeTimeUpper = _GetGroupElementPtr(groupindex, subindex);
827 if (!pCompositeTimeUpper)
return;
828 pCompositeTimeUpper->main = value;
841 ECompositeTimeUpper* pCompositeTimeUpper = _GetGroupElementPtr(groupindex, subindex);
842 if (!pCompositeTimeUpper)
return;
843 if (value == std::floor(value))
845 pCompositeTimeUpper->main = std::floor(value);
846 pCompositeTimeUpper->fraction = 0;
851 double fraction = std::modf(value, &integer);
852 pCompositeTimeUpper->main = integer;
853 pCompositeTimeUpper->fraction = MAKE_TWOBYTE(120, std::lround(fraction * 120.0));
867 if (_arraycounter == 0)
return false;
870#ifdef PDK_FRAMEWORK_DIAGNOSE
871 DebugOut(
"FCCompositeTimeSigTop()::SaveAll(): No existing collection items to read CMPER.");
875 _RedistributeArray();
877 CMPER cmper = pFirstInci->
_GetDataID()->other.cmper;
886 if (_arraycounter == 0)
return false;
888 _RedistributeArray(cmper);
892#ifdef PDK_FRAMEWORK_DIAGNOSE
893 DebugOut(
"FCCompositeTimeSigTop()::SaveAllForItem(): No existing collection items to read CMPER.");
908#ifdef PDK_FRAMEWORK_COMPOSITETIMESIGS
922 ECompositeTimeLower* _pArray;
928#ifndef DOXYGEN_SHOULD_IGNORE_THIS
933 ECompositeTimeLower* _GetGroupElementPtr(
int groupindex,
int subindex)
const
936 int currentindex = 0;
937 int subindexcount = 0;
938 for (
int i = 0; i < _arraycounter; i++)
940 if (_pArray[i].chainstart) currentindex++;
941 if (currentindex == groupindex)
943 if (subindexcount == subindex)
return &_pArray[i];
946 if (currentindex > groupindex)
return NULL;
957 void _RedistributeArray(CMPER cmper = 0)
963 cmper = pFirstInci->
_GetDataID()->other.cmper;
968 EDataID* pDataID = NULL;
969 for (
int i = 0; i < _arraycounter; i++)
974 pDataID = (EDataID*) pCurrentObject->
_GetDataID();
975 pDataID->other.cmper = cmper;
976 pDataID->other.inci = inci;
978 memcpy(pCurrentObject->
_GetFirstRecordPtr(), &_pArray[i], sizeof (ECompositeTimeLower));
984 memcpy(pCurrentObject->
_GetThirdRecordPtr(), &_pArray[i], sizeof (ECompositeTimeLower));
986 pCurrentObject = NULL;
990 if (pCurrentObject)
Add(pCurrentObject);
994#ifndef DOXYGEN_SHOULD_IGNORE_THIS
999#ifndef DOXYGEN_SHOULD_IGNORE_THIS
1008 int activerecords = 0;
1009 for (
int i = 0; i <
GetCount(); i++)
1013 if (pCompositeTimeLower->main == 0)
continue;
1016 if (pCompositeTimeLower->main == 0)
continue;
1019 if (pCompositeTimeLower->main == 0)
continue;
1022 if (activerecords == 0)
return;
1024 _pArray =
new ECompositeTimeLower[activerecords];
1025 int currentindex = 0;
1026 for (
int i = 0; i <
GetCount(); i++)
1030 if (pCompositeTimeLower->main == 0)
continue;
1031 memcpy(&_pArray[currentindex], pCompositeTimeLower,
sizeof(ECompositeTimeLower));
1034 if (pCompositeTimeLower->main == 0)
continue;
1035 memcpy(&_pArray[currentindex], pCompositeTimeLower,
sizeof(ECompositeTimeLower));
1038 if (pCompositeTimeLower->main == 0)
continue;
1039 memcpy(&_pArray[currentindex], pCompositeTimeLower,
sizeof(ECompositeTimeLower));
1042 _arraycounter = activerecords;
1046 const char*
ClassName()
const override {
return "FCCompositeTimeSigBottom"; }
1076 for (
int i = 0; i < _arraycounter; i++)
1078 if (_pArray[i].chainstart) groupcount++;
1094 int currentindex = 0;
1096 for (
int i = 0; i < _arraycounter; i++)
1098 if (_pArray[i].chainstart) currentindex++;
1099 if (currentindex == groupindex) count++;
1100 if (currentindex > groupindex)
return count;
1116 ECompositeTimeLower* pCompositeTimeLower = _GetGroupElementPtr(groupindex, subindex);
1117 if (!pCompositeTimeLower)
return 0;
1118 return pCompositeTimeLower->main;
1127 return _arraycounter;
1140 if (elementcount < 1)
return -1;
1141 if (elementcount > 10)
return -1;
1143 ECompositeTimeLower* pNewArray =
new ECompositeTimeLower[_arraycounter + elementcount];
1148 int bytesize =
sizeof(ECompositeTimeLower) * _arraycounter;
1149 memcpy(pNewArray, _pArray, bytesize);
1154 ECompositeTimeLower* pNewAddedData = &pNewArray[_arraycounter];
1155 for (
int i = 0; i < elementcount; i++)
1157 pNewAddedData->chainstart = (i == 0);
1158 pNewAddedData->main = 1024;
1163 _arraycounter += elementcount;
1164 _pArray = pNewArray;
1181 if (groupindex < 0)
return false;
1185 for (
int idx = groupindex; idx < _arraycounter - 1; idx ++)
1205 ECompositeTimeLower* pCompositeTimeLower = _GetGroupElementPtr(groupindex, subindex);
1206 if (!pCompositeTimeLower)
return;
1207 pCompositeTimeLower->main = value;
1220 if (_arraycounter == 0)
return false;
1223#ifdef PDK_FRAMEWORK_DIAGNOSE
1224 DebugOut(
"FCCompositeTimeSigBottom()::SaveAll(): No existing collection items to read CMPER.");
1228 _RedistributeArray();
1230 CMPER cmper = pFirstInci->
_GetDataID()->other.cmper;
1239 if (_arraycounter == 0)
return false;
1240 _RedistributeArray(cmper);
1243#ifdef PDK_FRAMEWORK_DIAGNOSE
1244 DebugOut(
"FCCompositeTimeSigBottom()::SaveAllForItem(): No existing collection items to read CMPER.");
1258#ifdef PDK_FRAMEWORK_SHAPES
1260#ifndef DOXYGEN_SHOULD_IGNORE_THIS
1262#include "pragma_align_begin.h"
1263#if OPERATING_SYSTEM == WINDOWS
1264struct __EDTPathData2014
1270#elif OPERATING_SYSTEM == MAC_OS
1271struct __EDTPathData2014
1278#include "pragma_align_end.h"
1293 EDTPathData2002* _pPathDataOld;
1294 __EDTPathData2014* _pPathData2014;
1295#if FXT_VERSION >= FINALEVERSION_2014B
1296 EDTPathData2014b* _pPathData2014b;
1300 bool _Is2014Format()
const;
1301 bool _Is2014bFormat()
const;
1303 void _SetTag(ETAG tag)
1309 void _AllocateParameters(
int parametercount);
1312 void _SetFourbyteParameter(
int parameterindex, fourbyte intvalue);
1386 const char*
ClassName()
const override {
return "FCShapeDefInstruction"; }
1401 void _SetMemory(EDTPathInst* pPathInstruction,
void* pPathData,
int offset);
1428 if(!pTestInstruction)
return false;
1430 if (
GetTag() != pTestInstruction->
GetTag())
return false;
1432 for (
int i = 0; i < count; i++)
1451 case st_startobject:
1536 if (index < 0)
return false;
1537 if (index >= _size)
return false;
1538 _SetFourbyteParameter(index, fbvalue);
1563 void Init_StartObject(
int xorigin,
int yorigin,
int left,
int top,
int right,
int bottom,
int xtransform = 1000,
int ytransform = 1000,
int rotation = 0)
1565 _SetTag(st_startobject);
1566 _AllocateParameters(11);
1567 _SetFourbyteParameter(0, xorigin);
1568 _SetFourbyteParameter(1, yorigin);
1569 _SetFourbyteParameter(2, left);
1570 _SetFourbyteParameter(3, top);
1571 _SetFourbyteParameter(4, right);
1572 _SetFourbyteParameter(5, bottom);
1573 _SetFourbyteParameter(6, xtransform);
1574 _SetFourbyteParameter(7, ytransform);
1575 _SetFourbyteParameter(8, rotation);
1583 void Init_StartGroup(
int xorigin,
int yorigin,
int left,
int top,
int right,
int bottom,
int xtransform = 1000,
int ytransform = 1000,
int rotation = 0)
1585 _SetTag(st_startgroup);
1586 _AllocateParameters(11);
1587 _SetFourbyteParameter(0, xorigin);
1588 _SetFourbyteParameter(1, yorigin);
1589 _SetFourbyteParameter(2, left);
1590 _SetFourbyteParameter(3, top);
1591 _SetFourbyteParameter(4, right);
1592 _SetFourbyteParameter(5, bottom);
1593 _SetFourbyteParameter(6, xtransform);
1594 _SetFourbyteParameter(7, ytransform);
1595 _SetFourbyteParameter(8, rotation);
1604 _SetTag(st_endgroup);
1605 _AllocateParameters(0);
1611 _SetTag(st_rmoveto);
1612 _AllocateParameters(2);
1613 _SetFourbyteParameter(0, x);
1614 _SetFourbyteParameter(1, y);
1618 void Init_CurveTo(
int x1,
int y1,
int x2,
int y2,
int endpt_x,
int endpt_y)
1620 _SetTag(st_curveto);
1621 _AllocateParameters(6);
1622 _SetFourbyteParameter(0, x1);
1623 _SetFourbyteParameter(1, y1);
1624 _SetFourbyteParameter(2, x2);
1625 _SetFourbyteParameter(3, y2);
1626 _SetFourbyteParameter(4, endpt_x);
1627 _SetFourbyteParameter(5, endpt_y);
1631 void Init_Slur(
int x1,
int y1,
int x2,
int y2,
int endpt_x,
int endpt_y)
1634 _AllocateParameters(6);
1635 _SetFourbyteParameter(0, x1);
1636 _SetFourbyteParameter(1, y1);
1637 _SetFourbyteParameter(2, x2);
1638 _SetFourbyteParameter(3, y2);
1639 _SetFourbyteParameter(4, endpt_x);
1640 _SetFourbyteParameter(5, endpt_y);
1649 _SetTag(st_linewidth);
1650 _AllocateParameters(1);
1651 _SetFourbyteParameter(0, linewidth);
1659 _SetTag(st_setgray);
1660 _AllocateParameters(1);
1661 _SetFourbyteParameter(0, greyvalue);
1667 _SetTag(st_fillsolid);
1668 _AllocateParameters(0);
1674 _SetTag(st_closepath);
1675 _AllocateParameters(0);
1685 _SetTag(st_ellipse);
1686 _AllocateParameters(2);
1687 _SetFourbyteParameter(0, width);
1688 _SetFourbyteParameter(1, height);
1697 _SetTag(st_rectangle);
1698 _AllocateParameters(2);
1699 _SetFourbyteParameter(0, width);
1700 _SetFourbyteParameter(1, height);
1708 _SetTag(st_drawchar);
1709 _AllocateParameters(1);
1710 _SetFourbyteParameter(0, character);
1718 _SetTag(st_setfont);
1719 _AllocateParameters(3);
1720 _SetFourbyteParameter(0, pFontInfo->
GetIDByName());
1721 _SetFourbyteParameter(1, pFontInfo->
GetSize());
1729 _SetTag(st_setdash);
1730 _AllocateParameters(2);
1731 _SetFourbyteParameter(0, dashlength);
1732 _SetFourbyteParameter(1, spacebetween);
1738 _SetTag(st_rlineto);
1739 _AllocateParameters(2);
1740 _SetFourbyteParameter(0, x);
1741 _SetFourbyteParameter(1, y);
1747 _SetTag(st_bracket);
1748 _AllocateParameters(1);
1749 _SetFourbyteParameter(0, brackettype);
1756 _AllocateParameters(0);
1763 _AllocateParameters(0);
1767#if PDK_FRAMEWORK_DEBUG
1776 for (
int i = 0; i < _size; i++)
1778 FCString parameterstring(
"Parameter ");
1793#ifdef PDK_FRAMEWORK_SHAPES
1806 const char*
ClassName()
const override {
return "FCShapeDefInstructions"; }
1826 return pInstruction;
1847 int xtransform = 1000,
int ytransform = 1000,
1850 if (!pOrigin)
return NULL;
1851 if (!pBoundLeftTop)
return NULL;
1852 if (!pBoundRightBottom)
return NULL;
1856 (
int) pOrigin->
GetY(),
1857 (
int) pBoundLeftTop->
GetX(),
1858 (
int) pBoundLeftTop->
GetY(),
1859 (
int) pBoundRightBottom->
GetX(),
1860 (
int) pBoundRightBottom->
GetY(),
1861 xtransform, ytransform, rotation);
1863 return pInstruction;
1874 int xtransform = 1000,
int ytransform = 1000,
1877 if (!pOrigin)
return NULL;
1878 if (!pBoundLeftTop)
return NULL;
1879 if (!pBoundRightBottom)
return NULL;
1883 (
int) pOrigin->
GetY(),
1884 (
int) pBoundLeftTop->
GetX(),
1885 (
int) pBoundLeftTop->
GetY(),
1886 (
int) pBoundRightBottom->
GetX(),
1887 (
int) pBoundRightBottom->
GetY(),
1888 xtransform, ytransform, rotation);
1890 return pInstruction;
1900 return pInstruction;
1916 return pInstruction;
1930 return pInstruction;
1942 return pInstruction;
1955 return pInstruction;
1970 return pInstruction;
1985 return pInstruction;
2004 pInstruction->
Init_CurveTo(72, ctrlpt_height, 144, 0, 72, -ctrlpt_height);
2006 return pInstruction;
2036 pInstruction->
Init_CurveTo(x1, y1, x2, y2, endpt_x, endpt_y);
2038 return pInstruction;
2051 pInstruction->
Init_Slur(72, ctrlpt_height, 144, 0, 72, -ctrlpt_height);
2053 return pInstruction;
2066 return pInstruction;
2081 return pInstruction;
2096 return pInstruction;
2110 return pInstruction;
2134 return pInstruction;
2148 if (!pFontInfo)
return NULL;
2152 return pInstruction;
2179 if (!pszString)
return NULL;
2180 int length = (int) strlen(pszString);
2182 for (
int i = 0; i < length; i++)
2202 if (!pString)
return NULL;
2205 for (
int i = 0; i < length; i++)
2214#ifdef PDK_FRAMEWORK_SHAPES
2215#define __ot_Shape_WORKAROUNDTAG MAKEEXTAG(edOther,'S','D')
2239 SHAPEDEFTYPE_UNKNOWN = -1,
2240 SHAPEDEFTYPE_OTHER = 0,
2241 SHAPEDEFTYPE_ARTICULATION = 1,
2242 SHAPEDEFTYPE_BARLINE = 2,
2243 SHAPEDEFTYPE_EXECUTABLESHAPE = 3,
2244 SHAPEDEFTYPE_EXPRESSION = 4,
2245 SHAPEDEFTYPE_NOTE = 5,
2246 SHAPEDEFTYPE_FRAME = 6,
2247 SHAPEDEFTYPE_ARROWHEAD = 7,
2248 SHAPEDEFTYPE_FRETBOARD = 8,
2249 SHAPEDEFTYPE_CLEF = 9
2253#ifndef DOXYGEN_SHOULD_IGNORE_THIS
2254 EDTShape* _TypeCast()
const {
return (EDTShape*)
_datablock; }
2255#if FXT_VERSION >= FINALEVERSION_2014B
2256 EDTShape2014b* _TypeCast2014b()
const {
return (EDTShape2014b*)
_datablock; }
2263 void _AllocateMemory(
int size)
2276 bool _Is2014Format()
const;
2278 bool _Is2014bFormat()
const;
2287 if (_Is2014bFormat())
return true;
2291 dataID.other.cmper =
_dataid.other.cmper;
2292 dataID.other.inci = 0;
2293 fourbyte size =
sizeof(oneinci);
2295 if (!FX_LoadEData(__ot_Shape_WORKAROUNDTAG, &dataID, &oneinci, &size))
return false;
2296 oneinci[2] = (twobyte) shapedeftype;
2297 _shapedeftype = shapedeftype;
2298 return FX_SaveEData(__ot_Shape_WORKAROUNDTAG, &dataID, &oneinci, size) != 0;
2308 if (_Is2014bFormat())
return true;
2312 dataID.other.cmper =
_dataid.other.cmper;
2313 dataID.other.inci = 0;
2314 fourbyte size =
sizeof(oneinci);
2316 if (!FX_LoadEData(__ot_Shape_WORKAROUNDTAG, &dataID, &oneinci, &size))
return false;
2333 _isemptyshape = ((
FCShapeDef*) pSource)->_GetIsEmptyShape();
2341#if !defined(__LP64__) && !defined(_WIN64)
2342 if (!_Is2014bFormat())
2345 SetCustomTag((size ==
sizeof(EDTShape)) ? __ot_Shape_WORKAROUNDTAG : ot_Shape);
2373 EDTPathInst* _GetPathInstructionArray()
2375 if (_isemptyshape)
return NULL;
2376 if (_Is2014bFormat())
2378#if FXT_VERSION >= FINALEVERSION_2014B
2379 return (EDTPathInst*) ((
char *)
_datablock + _TypeCast2014b()->instrucOff);
2384 return (EDTPathInst*) ((
char *)
_datablock + _TypeCast()->instrucOff);
2394 void* _GetPathDataArray()
2396 if (_isemptyshape)
return NULL;
2397 if (_Is2014bFormat())
2399#if FXT_VERSION >= FINALEVERSION_2014B
2400 return (
void*) ((
char *)
_datablock + _TypeCast2014b()->dataOff);
2405 return (
void*) ((
char *)
_datablock + _TypeCast()->dataOff);
2419 bool _EmptyShapeCheck(CMPER cmper,
bool* pIsEmpty)
2421#ifdef PDK_FRAMEWORK_DIAGNOSE
2422 if (_Is2014bFormat())
2424 DebugOut(
"FCShapeDef::_EmptyShapeCheck was called on 2014b struct.");
2432 memset(&shapetest, 0,
sizeof(shapetest));
2434 dataID.other.cmper = cmper;
2435 dataID.other.inci = 0;
2436 fourbyte size =
sizeof(shapetest);
2438 bool result = FX_LoadEData(__ot_Shape_WORKAROUNDTAG,
2440 if (!result)
return false;
2441 int loopcount = size /
sizeof(twobyte);
2442 twobyte* pNonZeroCheck = (twobyte*) &shapetest;
2443 for (
int i = 0; i < loopcount; i++)
2445 if (pNonZeroCheck[i])
2447 if (i == 1)
continue;
2449 if (i == 2)
continue;
2465 void* _GetInstructionDataPointer(
int index);
2469 const char*
ClassName()
const override {
return "FCShapeDef"; }
2475 _isemptyshape =
true;
2476 _shapedeftype = SHAPEDEFTYPE_UNKNOWN;
2494 if (_Is2014bFormat())
return false;
2499 dataID.other.inci = 0;
2500 fourbyte size =
sizeof(buffer);
2501 memset(buffer, 0,
sizeof(buffer));
2502 if (!FX_LoadEData(__ot_Shape_WORKAROUNDTAG, &dataID, buffer, &size, FINALEVERSION_2010))
return false;
2503 return ((buffer[2] & 0x0008) != 0);
2531 bool result =
false;
2532 if (_Is2014bFormat())
2538#if FXT_VERSION >= FINALEVERSION_2014B
2541 _isemptyshape = (_TypeCast2014b()->instrucLen == 0);
2546 _shapedeftype = SHAPEDEFTYPE_UNKNOWN;
2547 _isemptyshape =
true;
2553 if (!_EmptyShapeCheck(itemno, &isemptyshape))
return false;
2554 SetCustomTag(isemptyshape ? __ot_Shape_WORKAROUNDTAG : ot_Shape);
2555 _isemptyshape = isemptyshape;
2560 _shapedeftype = SHAPEDEFTYPE_UNKNOWN;
2578#ifndef PDK_FRAMEWORK_LUAFRIENDLY
2585 if (_Is2014bFormat())
2587#if FXT_VERSION >= FINALEVERSION_2014B
2591 return _shapedeftype;
2604#ifndef PDK_FRAMEWORK_LUAFRIENDLY
2612 if (_Is2014bFormat())
2615#if FXT_VERSION >= FINALEVERSION_2014B
2616 _TypeCast2014b()->shapeType = shapedeftype;
2620 if (!_Is2014bFormat())
2639#ifndef PDK_FRAMEWORK_LUAFRIENDLY
2646 if (_Is2014bFormat())
2649#if FXT_VERSION >= FINALEVERSION_2014B
2650 _TypeCast2014b()->shapeType = shapedeftype;
2653 if (!
Save())
return false;
2654 if (!_Is2014bFormat())
2668 if (_Is2014bFormat())
2670#if FXT_VERSION >= FINALEVERSION_2014B
2671 return _isemptyshape ? 0 : _TypeCast2014b()->dataLen;
2676 return _isemptyshape ? 0 : _TypeCast()->dataLen;
2691 if (_Is2014bFormat())
2693#if FXT_VERSION >= FINALEVERSION_2014B
2695 returnval = _TypeCast2014b()->instrucLen;
2700 returnval = _isemptyshape ? 0 : _TypeCast()->instrucLen;
2703 if ((returnval > 300) || (returnval < 0))
return -1;
2718 if (index < 0)
return 0;
2720 EDTPathInst* pPathArray = _GetPathInstructionArray();
2721 return pPathArray[index].tag;
2728 if (index < 0)
return -1;
2730 EDTPathInst* pPathArray = _GetPathInstructionArray();
2731 return pPathArray[index].numdata;
2746#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
2748 luabridge::RefCountedPtr<FCShapeDefInstructions> CreateInstructions_GC()
2767#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
2769 luabridge::RefCountedPtr<FCStrings> CreateTextStrings_GC()
2819#ifdef PDK_FRAMEWORK_DEBUG
2826 DebugOutInt(
"sizeof EDTShape: ",
sizeof(EDTShape));
2827 DebugOutInt(
"sizeof EDTPathInst: ",
sizeof(EDTPathInst));
2828 DebugOutInt(
"sizeof EDTPathData2002: ",
sizeof(EDTPathData2002));
2873#ifndef DOXYGEN_SHOULD_IGNORE_THIS
2875 EDTEnclosure _enclosuredataold;
2878 FIN25_4_CODE(EDTEnclosure25_4 _enclosuredata25_4;)
2883 EDTEnclosure* _pEnclosureOld;
2884 FIN25_4_CODE(EDTEnclosure25_4* _pEnclosure25_4;)
2888 bool Use25_4Version()
const;
2891 const FLAG_16* _GetFlagPtr()
const
2893 FIN25_4_CODE(
if (Use25_4Version())
return &_pEnclosure25_4->flag; )
2894 return &_pEnclosureOld->flag;
2898 const EVPUFixedShort* _GetLineWidthPtr()
const
2900 FIN25_4_CODE(
if (Use25_4Version())
return &_pEnclosure25_4->lineWidth; )
2901 return &_pEnclosureOld->lineWidth;
2905 const Evpu16* _GetXAddPtr()
const
2907 FIN25_4_CODE(
if (Use25_4Version())
return &_pEnclosure25_4->xAdd; )
2908 return &_pEnclosureOld->xAdd;
2912 const Evpu16* _GetYAddPtr()
const
2914 FIN25_4_CODE(
if (Use25_4Version())
return &_pEnclosure25_4->yAdd; )
2915 return &_pEnclosureOld->yAdd;
2919 const Evpu16* _GetXMarginPtr()
const
2921 FIN25_4_CODE(
if (Use25_4Version())
return &_pEnclosure25_4->xMargin; )
2922 return &_pEnclosureOld->xMargin;
2926 const Evpu16* _GetYMarginPtr()
const
2928 FIN25_4_CODE(
if (Use25_4Version())
return &_pEnclosure25_4->yMargin; )
2929 return &_pEnclosureOld->yMargin;
2933 EXTAG
Tag()
const override
2936 FIN25_4_CODE(
if (Use25_4Version())
return ot_TextExpEnclosure25_4; )
2937 return ot_TextExpEnclosure;
2941 FIN25_4_CODE(
if (Use25_4Version())
return sizeof(EDTEnclosure25_4); )
2942 return sizeof(EDTEnclosure);
2948 FIN25_4_CODE(
if (Use25_4Version())
return (
void*) _pEnclosure25_4; )
2949 return (
void*) _pEnclosureOld;
2958 void* pData = _GetEnclosure();
2960 memcpy(pData, ((
FCEnclosure*)pSource)->_GetEnclosure(), size);
2969 const char*
ClassName()
const override {
return "FCEnclosure"; }
2972#ifndef DOXYGEN_SHOULD_IGNORE_THIS
2981 void* _GetEnclosure()
const {
2982 FIN25_4_CODE(
if (Use25_4Version())
return (
void*) _pEnclosure25_4; )
2983 return (
void*) _pEnclosureOld;
3054 if (Use25_4Version())
3056 FIN25_4_CODE( _pEnclosure25_4 = &_enclosuredata25_4; )
3060 _pEnclosureOld = &_enclosuredataold;
3062 void* pData = _GetEnclosure();
3072 if (Use25_4Version())
3074 FIN25_4_CODE( _pEnclosure25_4 = (EDTEnclosure25_4*) pPointer; )
3078 _pEnclosureOld = (EDTEnclosure*) pPointer;
3089#ifndef PDK_FRAMEWORK_LUAFRIENDLY
3096 if (!_GetEnclosure())
return;
3097 if (shape < 0)
return;
3098 if (shape > 15)
return;
3099 *(FLAG_16*)_GetFlagPtr() &= ~NEWSIDES;
3100 *(FLAG_16*)_GetFlagPtr() |= shape;
3111 if (!_GetEnclosure())
return;
3112 *(Evpu16*)_GetLineWidthPtr() = width;
3121 if (!_GetEnclosure())
return;
3122 *(Evpu16*)_GetXAddPtr() = offset;
3131 if (!_GetEnclosure())
return;
3132 *(Evpu16*)_GetYAddPtr() = offset;
3142 if (!_GetEnclosure())
return;
3143 *(Evpu16*)_GetXMarginPtr() = margin;
3153 if (!_GetEnclosure())
return;
3154 *(Evpu16*)_GetYMarginPtr() = margin;
3163 if (!_GetEnclosure())
return;
3164 Set16BitFlag((FLAG_16*)_GetFlagPtr(), FIXED_SIZE, state);
3173 if (!_GetEnclosure())
return;
3174 Set16BitFlag((FLAG_16*)_GetFlagPtr(), ENCL_OPAQUE, state);
3186 FIN25_4_CODE(
if (Use25_4Version())
Set16BitFlag((FLAG_16*)_GetFlagPtr(), 0x0400 , state); )
3198 FIN25_4_CODE(
if (Use25_4Version()) _pEnclosure25_4->m_cornerRadius = radius; )
3206#ifndef PDK_FRAMEWORK_LUAFRIENDLY
3213 switch (enclosuremode)
3216 Set16BitFlag((FLAG_16*)_GetFlagPtr(), NOT_TALL,
false);
3217 Set16BitFlag((FLAG_16*)_GetFlagPtr(), EQUAL_ASPECT,
false);
3221 Set16BitFlag((FLAG_16*)_GetFlagPtr(), EQUAL_ASPECT,
false);
3224 Set16BitFlag((FLAG_16*)_GetFlagPtr(), NOT_TALL,
false);
3225 Set16BitFlag((FLAG_16*)_GetFlagPtr(), EQUAL_ASPECT,
true);
3237#ifndef PDK_FRAMEWORK_LUAFRIENDLY
3255 if (!_GetEnclosure())
return 0;
3256 return *_GetLineWidthPtr();
3265 if (!_GetEnclosure())
return 0;
3266 return *_GetXAddPtr();
3275 if (!_GetEnclosure())
return 0;
3276 return *_GetYAddPtr();
3286 if (!_GetEnclosure())
return 0;
3287 return *_GetXMarginPtr();
3297 if (!_GetEnclosure())
return 0;
3298 return *_GetYMarginPtr();
3307 if (!_GetEnclosure())
return false;
3308 return GetBitFlag(*_GetFlagPtr(), FIXED_SIZE);
3317 if (!_GetEnclosure())
return false;
3318 return GetBitFlag(*_GetFlagPtr(), ENCL_OPAQUE);
3331 FIN25_4_CODE(
if (Use25_4Version())
return GetBitFlag(*_GetFlagPtr(), 0x0400 ); )
3344 FIN25_4_CODE(
if (Use25_4Version())
return _pEnclosure25_4->m_cornerRadius; )
3352#ifndef PDK_FRAMEWORK_LUAFRIENDLY
3376#ifdef PDK_FRAMEWORK_DEBUG
3386#ifdef PDK_FRAMEWORK_LAYOUT
3399#ifndef DOXYGEN_SHOULD_IGNORE_THIS
3402 EDTPageSpec pagespec;
3404 EXTAG
Tag()
const override {
return ot_EDTPageSpec; }
3405 int DataSizeLoad()
const override {
return sizeof(EDTPageSpec); }
3406 void*
Allocate()
override {
return (
void*) &pagespec; }
3414 memcpy(&pagespec, ((
FCPage*)pSource)->_GetPageSpec(),
sizeof(pagespec));
3425#ifndef DOXYGEN_SHOULD_IGNORE_THIS
3432 void* _GetPageSpec() {
return &pagespec; }
3484 return pagespec.stavestr == -1;
3570 void SetWidth(Evpu32 width) { pagespec.width = width; }
3686#ifdef PDK_FRAMEWORK_DEBUG
3698#ifdef PDK_FRAMEWORK_LAYOUT
3700#ifdef PDK_FRAMEWORK_DEBUG
3716#ifndef DOXYGEN_SHOULD_IGNORE_THIS
3719 EDTStaffSystemSpec2005 _staffsystem;
3721 EXTAG
Tag()
const override {
return ot_EDTStaffSystemSpec; }
3722 int DataSizeLoad()
const override {
return sizeof(EDTStaffSystemSpec2005); }
3723 void*
Allocate()
override {
return (
void*) &_staffsystem; }
3731 memcpy(&_staffsystem, ((
FCStaffSystem*)pSource)->_GetStaffSystemSpec(),
sizeof(_staffsystem));
3740 const char*
ClassName()
const override {
return "FCStaffSystem"; }
3743#ifndef DOXYGEN_SHOULD_IGNORE_THIS
3750 void* _GetStaffSystemSpec() {
return &_staffsystem; }
3759#ifdef PDK_FRAMEWORK_DEBUG
3764 if ((offsetof(EDTStaffSystemSpec2005, horzPercent) - offsetof(EDTStaffSystemSpec2005, mend)) != 2)
3766 DebugOut(
"ERROR: Packed struct alignment isn't set up correctly in the compiler options! Use "
3767 "-fpack-struct=1 for GCC.");
3782 { ((EDTStaffSystemSpec2005*)
_datablock)->mestart = measure; }
3793 { ((EDTStaffSystemSpec2005*)
_datablock)->mend = measure; }
3801 { ((EDTStaffSystemSpec2005*)
_datablock)->extraStartSystemSpace = space; }
3809 { ((EDTStaffSystemSpec2005*)
_datablock)->extraEndSystemSpace = space; }
3817 { ((EDTStaffSystemSpec2005*)
_datablock)->betweensystems = -space; }
3828 { ((EDTStaffSystemSpec2005*)
_datablock)->top = -margin; }
3841 { ((EDTStaffSystemSpec2005*)
_datablock)->bottom = -margin; }
3851 { ((EDTStaffSystemSpec2005*)
_datablock)->left = margin; }
3860 { ((EDTStaffSystemSpec2005*)
_datablock)->right = margin; }
3868 _staffsystem.ssysPercent = value;
3884 { _staffsystem.staffHeight = value; }
3893 Set16BitFlag(&_staffsystem.staveflag, SSPEC_RESIZE_VERT, value);
3905 Set16BitFlag(&_staffsystem.staveflag, SSPEC_LINEPERC, state);
3914 Set16BitFlag(&_staffsystem.staveflag, SSPEC_HOLD_MARGINS, state);
3924 {
return ((EDTStaffSystemSpec2005*)
_datablock)->mestart; }
3931 {
return ((EDTStaffSystemSpec2005*)
_datablock)->mend; }
3938 {
return ((EDTStaffSystemSpec2005*)
_datablock)->extraStartSystemSpace; }
3946 {
return ((EDTStaffSystemSpec2005*)
_datablock)->extraEndSystemSpace; }
3955 {
return -((EDTStaffSystemSpec2005*)
_datablock)->betweensystems; }
3963 {
return -((EDTStaffSystemSpec2005*)
_datablock)->top; }
3970 {
return -((EDTStaffSystemSpec2005*)
_datablock)->bottom; }
3980 {
return ((EDTStaffSystemSpec2005*)
_datablock)->left; }
3988 {
return ((EDTStaffSystemSpec2005*)
_datablock)->right; }
3999 {
return ((EDTStaffSystemSpec2005*)
_datablock)->staffHeight; }
4006 {
return ((EDTStaffSystemSpec2005*)
_datablock)->ssysPercent; }
4025 return GetBitFlag(_staffsystem.staveflag, SSPEC_LINEPERC);
4034 return GetBitFlag(_staffsystem.staveflag, SSPEC_HOLD_MARGINS);
4054 return _staffsystem.horzPercent;
4148#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
4150 luabridge::RefCountedPtr<FCSystemStaves> CreateSystemStaves_GC()
4171#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
4173 luabridge::RefCountedPtr<FCFreezeSystem> CreateFreezeSystem_GC(
bool force_create)
4190#ifdef PDK_FRAMEWORK_DEBUG
4223#ifndef DOXYGEN_SHOULD_IGNORE_THIS
4243 EVERSION _VersionToUse()
const;
4248 EDTMeasureSpec2005 _measurespec2005;
4250#if FXT_VERSION >= FINALEVERSION_2014
4251 EDTMeasureSpec2014 _measurespec2014;
4257 FLAG_16* _GetMeFlagPtr()
const;
4262 FLAG_16* _GetNewFlagPtr()
const;
4267 FLAG_16* _GetAuxFlagPtr()
const;
4272 void _SetMeFlag(FLAG_16 mask,
bool state);
4277 bool _GetMeFlag(FLAG_16 mask)
const
4285 void _SetNewFlag(FLAG_16 mask,
bool state);
4290 bool _GetNewFlag(FLAG_16 mask)
const {
return GetBitFlag(*_GetNewFlagPtr(), mask); }
4295 void _SetAuxFlag(FLAG_16 mask,
bool state);
4300 bool _GetAuxFlag(FLAG_16 mask)
const {
return GetBitFlag(*_GetAuxFlagPtr(), mask); }
4306 FCString* _CreateNumberString(
bool qualified,
bool showAllRepeatPasses)
4309 eUniChar16 buffer[512];
4310 if (! FX_GetMeasureNumberString(
GetItemNo(), buffer, DIM(buffer), qualified, showAllRepeatPasses))
4323 return _VersionToUse();
4325 EXTAG
Tag()
const override {
return ot_MeasureSpec; }
4327#if FXT_VERSION >= FINALEVERSION_2014
4328 if (_VersionToUse() == FINALEVERSION_2014)
return sizeof(EDTMeasureSpec2014);
4330 return sizeof(EDTMeasureSpec2005);
4335#if FXT_VERSION >= FINALEVERSION_2014
4336 if (_VersionToUse() == FINALEVERSION_2014)
return (
void*) &_measurespec2014;
4338 return (
void*) &_measurespec2005;
4347#if FXT_VERSION >= FINALEVERSION_2014
4348 if (_VersionToUse() == FINALEVERSION_2014)
4350 memcpy(&_measurespec2014, ((
FCMeasure*)pSource)->_GetMeasureSpec(),
sizeof(_measurespec2014));
4356 memcpy(&_measurespec2005, ((
FCMeasure*)pSource)->_GetMeasureSpec(),
sizeof(_measurespec2005));
4407 bool _GetBarlineMask(
4408#ifdef PDK_FRAMEWORK_LUAFRIENDLY
4413 style, FLAG_16* pFlag);
4453 const char*
ClassName()
const override {
return "FCMeasure"; }
4456#ifndef DOXYGEN_SHOULD_IGNORE_THIS
4463 void* _GetMeasureSpec()
4465#if FXT_VERSION >= FINALEVERSION_2014
4466 if (_VersionToUse() == FINALEVERSION_2014)
return &_measurespec2014;
4468 return &_measurespec2005;
4481 _pTimeSigDisplay = NULL;
4489 if (_pKeySig)
delete _pKeySig;
4490 if (_pTimeSig)
delete _pTimeSig;
4491 if (_pTimeSigDisplay)
delete _pTimeSigDisplay;
4495 bool Save()
override;
4498 bool Load(CMPER itemno)
override;
4509#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
4511 luabridge::RefCountedPtr<FCBeatChartElements> CreateBeatChartElements_GC()
4524#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
4526 luabridge::RefCountedPtr<FCExpressions> CreateExpressions_GC()
4539#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
4541 luabridge::RefCountedPtr<FCTempoElements> CreateTempoElements_GC()
4550 if (_VersionToUse() != FINALEVERSION_2014)
return;
4551#if FXT_VERSION >= FINALEVERSION_2014
4552 _measurespec2014.isKeyless = state;
4560 if (_VersionToUse() != FINALEVERSION_2014)
return;
4561#if FXT_VERSION >= FINALEVERSION_2014
4562 _measurespec2014.hideKeySigShowAccis = state;
4576 { _SetNewFlag(MEAS_PAGEBREAK, state); }
4586 { _SetMeFlag(MEAS_BREAKREST, state); }
4595 { _SetMeFlag(MEAS_FORREPBAR, state); }
4606 { _SetMeFlag(MEAS_DYNAMBIT, state); }
4617 { _SetMeFlag(MEAS_MEASURETEXT, state); }
4632 { _SetMeFlag(MEAS_BACREPBAR, state); }
4685#if FXT_VERSION >= FINALEVERSION_2014
4686 if (_VersionToUse() == FINALEVERSION_2014)
4688 _measurespec2014.measpace = width;
4692 _measurespec2005.measpace = width;
4703#if FXT_VERSION >= FINALEVERSION_2014
4704 if (_VersionToUse() == FINALEVERSION_2014)
4706 _measurespec2014.frontSpaceExtra = space;
4710 _measurespec2005.frontSpaceExtra = space;
4721#if FXT_VERSION >= FINALEVERSION_2014
4722 if (_VersionToUse() == FINALEVERSION_2014)
4724 _measurespec2014.backSpaceExtra = space;
4728 _measurespec2005.backSpaceExtra = space;
4753#ifndef PDK_FRAMEWORK_LUAFRIENDLY
4770#ifndef PDK_FRAMEWORK_LUAFRIENDLY
4829#ifndef PDK_FRAMEWORK_LUAFRIENDLY
4852#ifdef PDK_FRAMEWORK_LUAFRIENDLY
4866#if FXT_VERSION >= FINALEVERSION_2014
4867 if (_VersionToUse() == FINALEVERSION_2014)
4869 _measurespec2014.custombarshape = shapeID;
4873 _measurespec2005.custombarshape = shapeID;
4884#if FXT_VERSION >= FINALEVERSION_2014
4885 if (_VersionToUse() == FINALEVERSION_2014)
4887 _measurespec2014.customleftbarshape = shapeID;
4891 _measurespec2005.customleftbarshape = shapeID;
4905#ifndef PDK_FRAMEWORK_LUAFRIENDLY
4937 return FX_GetMeasureDuration(0,
GetItemNo());
4948 if (_VersionToUse() != FINALEVERSION_2014)
return false;
4949#if FXT_VERSION >= FINALEVERSION_2014
4950 return _measurespec2014.isKeyless != 0;
4962 if (_VersionToUse() != FINALEVERSION_2014)
return false;
4963#if FXT_VERSION >= FINALEVERSION_2014
4964 return _measurespec2014.hideKeySigShowAccis != 0;
5078#if FXT_VERSION >= FINALEVERSION_2014
5079 if (_VersionToUse() == FINALEVERSION_2014)
5081 return _measurespec2014.measpace;
5084 return _measurespec2005.measpace;
5094#if FXT_VERSION >= FINALEVERSION_2014
5095 if (_VersionToUse() == FINALEVERSION_2014)
5097 return _measurespec2014.frontSpaceExtra;
5100 return _measurespec2005.frontSpaceExtra;
5110#if FXT_VERSION >= FINALEVERSION_2014
5111 if (_VersionToUse() == FINALEVERSION_2014)
5113 return _measurespec2014.backSpaceExtra;
5116 return _measurespec2005.backSpaceExtra;
5138#ifndef PDK_FRAMEWORK_LUAFRIENDLY
5154#ifndef PDK_FRAMEWORK_LUAFRIENDLY
5221#ifndef PDK_FRAMEWORK_LUAFRIENDLY
5242#ifdef PDK_FRAMEWORK_LUAFRIENDLY
5257#ifndef PDK_FRAMEWORK_LUAFRIENDLY
5271#if FXT_VERSION >= FINALEVERSION_2014
5272 if (_VersionToUse() == FINALEVERSION_2014)
5274 return _measurespec2014.custombarshape;
5277 return _measurespec2005.custombarshape;
5287#if FXT_VERSION >= FINALEVERSION_2014
5288 if (_VersionToUse() == FINALEVERSION_2014)
5290 return _measurespec2014.customleftbarshape;
5293 return _measurespec2005.customleftbarshape;
5312 if (_pKeySig)
return _pKeySig;
5314#if FXT_VERSION >= FINALEVERSION_2014
5315 if (_VersionToUse() == FINALEVERSION_2014)
5317 _pKeySig->
SetID(_measurespec2014.key);
5321 _pKeySig->
SetID(_measurespec2005.key);
5361 if (_pTimeSig)
return _pTimeSig;
5363#if FXT_VERSION >= FINALEVERSION_2014
5364 if (_VersionToUse() == FINALEVERSION_2014)
5366 _pTimeSig->
SetBeats(_measurespec2014.beats);
5371 _pTimeSig->
SetBeats(_measurespec2005.beats);
5394 if (_pTimeSigDisplay)
return _pTimeSigDisplay;
5396#if FXT_VERSION >= FINALEVERSION_2014
5397 if (_VersionToUse() == FINALEVERSION_2014)
5399 _pTimeSigDisplay->
SetBeats(_measurespec2014.dispBeats);
5404 _pTimeSigDisplay->
SetBeats(_measurespec2005.dispBeats);
5407 _pTimeSigDisplay->
SetCompositeTop(_GetNewFlag(MEAS_DISPLAY_ALTNUMTSIG));
5409 _pTimeSigDisplay->
SetAbbreviate(_GetNewFlag(MEAS_ABBRVTIME));
5410 return _pTimeSigDisplay;
5427 if (_pTimeSigDisplay)
5429 delete _pTimeSigDisplay;
5430 _pTimeSigDisplay = NULL;
5433 return _SetNewFlag(MEAS_USE_DISPLAY_TIMESIG, value);
5451 return _CreateNumberString(
true, showAllRepeatPasses);
5454#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
5456 luabridge::RefCountedPtr<FCString> CreateNumberString_GC(
bool showAllRepeatPasses =
false)
5475 return _CreateNumberString(
false, showAllRepeatPasses);
5478#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
5480 luabridge::RefCountedPtr<FCString> CreateNumberStringUnqualified_GC(
bool showAllRepeatPasses =
false)
5495#ifndef DOXYGEN_SHOULD_IGNORE_THIS
5503 FCNumbers* _pTempNonIncludedMeasuresStorage;
5506 FIN25_4_CODE(EDTMeasNumberRegion25_4 _measureregion25_4;)
5509 FIN2012_CODE(EDTMeasNumberRegion2012 _measureregion2012;)
5511 EDTMeasNumberRegion2010 _measureregion2010;
5512 EDTMeasNumberRegion _measureregionold;
5521 const FLAG_16* _GetScorePartFlagsPtr(
bool parts);
5524 const FLAG_16* _GetScorePartFlags2Ptr(
bool parts);
5527 const twobyte* _GetScorePartIncidencePtr(
bool parts)
const;
5530 const twobyte* _GetScorePartStartxdispPtr(
bool parts)
const;
5533 const twobyte* _GetScorePartStartydispPtr(
bool parts)
const;
5536 const twobyte* _GetScorePartMultiplexdispPtr(
bool parts)
const;
5539 const twobyte* _GetScorePartMultipleydispPtr(
bool parts)
const;
5542 const twobyte* _GetScorePartMmrestxdispPtr(
bool parts)
const;
5545 const twobyte* _GetScorePartMmrestydispPtr(
bool parts)
const;
5548 const twobyte* _GetScorePartStartWithPtr(
bool parts)
const;
5554 const void* _GetScorePartLeftMMBracketCharPtr(
bool parts)
const;
5560 const void* _GetScorePartRightMMBracketCharPtr(
bool parts)
const;
5563 const EFONTID* _GetScorePartStartFontPtr(
bool parts)
const;
5566 const FLAG_16* _GetScorePartStartEfxPtr(
bool parts)
const;
5569 const twobyte* _GetScorePartStartSizePtr(
bool parts)
const;
5572 const EFONTID* _GetScorePartMultipleFontPtr(
bool parts)
const;
5575 const FLAG_16* _GetScorePartMultipleEfxPtr(
bool parts)
const;
5578 const twobyte* _GetScorePartMultipleSizePtr(
bool parts)
const;
5581 const EFONTID* _GetScorePartMmRestFontPtr(
bool parts)
const;
5584 const FLAG_16* _GetScorePartMmRestEfxPtr(
bool parts)
const;
5587 const twobyte* _GetScorePartMmRestSizePtr(
bool parts)
const;
5590 const twobyte* _GetStartMeasPtr()
const;
5593 const twobyte* _GetEndMeasPtr()
const;
5596 const twobyte* _GetOffsetPtr()
const;
5600 const void* _GetPrefixPtr()
const;
5603 const void* _GetSuffixPtr()
const;
5606 const FLAG_16* _GetFlagPtr()
const;
5609 const FLAG_16* _GetFlag2Ptr()
const;
5612 const twobyte* _GetRegionPtr()
const;
5615 const twobyte* _GetBasePtr()
const;
5620 const void* _GetStartcharPtr()
const;
5622 bool _GetScorePartFlags(
bool parts, FLAG_16 flag);
5623 void _SetScorePartFlags(
bool parts, FLAG_16 flag,
bool state);
5625 FLAG_16 _GetScorePartFlagsValue(
bool parts);
5626 void _SetScorePartFlagsValue(
bool parts, FLAG_16 flag);
5627 FLAG_16 _GetScorePartFlags2Value(
bool parts);
5628 void _SetScorePartFlags2Value(
bool parts, FLAG_16 flag2);
5631 EVERSION _FXTVersionToUse()
const;
5636 void _FormatDisplayedNumberForIndex(twobyte meas_num_index,
FCString* pString);
5638 EXTAG
Tag()
const override {
return ot_MeasNumberRegion; }
5751 const char*
ClassName()
const override {
return "FCMeasureNumberRegion"; }
5754#ifndef DOXYGEN_SHOULD_IGNORE_THIS
5761 void* _GetData() {
return Allocate(); }
5816 void SetID(twobyte newid);
6023#ifndef PDK_FRAMEWORK_LUAFRIENDLY
6037#ifndef PDK_FRAMEWORK_LUAFRIENDLY
6051#ifndef PDK_FRAMEWORK_LUAFRIENDLY
6065#ifndef PDK_FRAMEWORK_LUAFRIENDLY
6079#ifndef PDK_FRAMEWORK_LUAFRIENDLY
6093#ifndef PDK_FRAMEWORK_LUAFRIENDLY
6168#ifndef PDK_FRAMEWORK_LUAFRIENDLY
6183#ifndef PDK_FRAMEWORK_LUAFRIENDLY
6470 return parts ? &_startEnclosureParts : &_startEnclosureScore;
6484 return parts ? &_multipleEnclosureParts : &_multipleEnclosureScore;
6595#ifndef PDK_FRAMEWORK_LUAFRIENDLY
6606#ifndef PDK_FRAMEWORK_LUAFRIENDLY
6619#ifndef PDK_FRAMEWORK_LUAFRIENDLY
6630#ifndef PDK_FRAMEWORK_LUAFRIENDLY
6643#ifndef PDK_FRAMEWORK_LUAFRIENDLY
6654#ifndef PDK_FRAMEWORK_LUAFRIENDLY
6703#ifndef PDK_FRAMEWORK_LUAFRIENDLY
6716#ifndef PDK_FRAMEWORK_LUAFRIENDLY
6756#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
6758 luabridge::RefCountedPtr<FCFontInfo> CreateStartFontInfo_GC(
bool parts)
6794#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
6796 luabridge::RefCountedPtr<FCFontInfo> CreateMultipleFontInfo_GC(
bool parts)
6832#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
6834 luabridge::RefCountedPtr<FCFontInfo> CreateMultiMeasureFontInfo_GC(
bool parts)
6854#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
6856 luabridge::RefCountedPtr<FCString> CreateDisplayedString_GC(twobyte measure)
6918 _pTempNonIncludedMeasuresStorage = _pNonIncludedMeasures;
6920 _pNonIncludedMeasures = pNonNumberedMeasuresToUse;
6930 _pNonIncludedMeasures = _pTempNonIncludedMeasuresStorage;
6933#ifdef PDK_FRAMEWORK_DEBUG
6953#ifndef DOXYGEN_SHOULD_IGNORE_THIS
6956 EDTInstrumentUsed _instrumentused;
6960 bool LoadFirst()
override {
return false; }
6962 EXTAG
Tag()
const override {
return ot_InstrumentUsed; }
6963 int DataSizeLoad()
const override {
return sizeof(EDTInstrumentUsed); }
6964 void*
Allocate()
override {
return (
void*) &_instrumentused; }
6972 memcpy(&_instrumentused, ((
FCSystemStaff*)pSource)->_GetDataPtr(),
sizeof(_instrumentused));
6981 const char*
ClassName()
const override {
return "FCSystemStaff"; }
6984#ifndef DOXYGEN_SHOULD_IGNORE_THIS
6991 void* _GetDataPtr() {
return &_instrumentused; }
7001 memset(&_instrumentused, 0,
sizeof(_instrumentused));
7008 bool Load(CMPER itemno, twobyte inci)
override;
7011 bool SaveNew(CMPER itemno)
override;
7014 bool Save()
override;
7024 void SetDistance(Evpu32 distance) { _instrumentused.separ = -distance; }
7030 void SetStaff(eStaff staffno) { _instrumentused.inst = staffno; }
7046 eStaff
GetStaff()
const override {
return _instrumentused.inst; }
7055 if (
_dataid.other.cmper == 0)
return 100;
7080 if (
_dataid.other.cmper == 0)
return false;
7083 dataID.detail.cmper1 =
_dataid.other.cmper;
7084 dataID.detail.cmper2 = _instrumentused.inst;
7085 dataID.detail.inci = 0;
7086 return FX_DeleteEData(dt_StaffEnduction, &dataID,
EnigmaVersion()) != 0;
7089#ifdef PDK_FRAMEWORK_DEBUG
7107#ifndef DOXYGEN_SHOULD_IGNORE_THIS
7110 EDTDrumStaff2010 _drumstaff;
7113 bool LoadFirst()
override {
return false; }
7116 int DataSizeLoad()
const override {
return sizeof(EDTDrumStaff2010); }
7117 void*
Allocate()
override {
return (
void*) &_drumstaff; }
7125 memcpy(&_drumstaff, ((
FCPercussionStaff*)pSource)->_GetDataPtr(),
sizeof(_drumstaff));
7133 const char*
ClassName()
const override {
return "FCPercussionStaff"; }
7136#ifndef DOXYGEN_SHOULD_IGNORE_THIS
7143 void* _GetDataPtr() {
return &_drumstaff; }
7149 memset(&_drumstaff, 0,
sizeof(_drumstaff));
7162 return _drumstaff.whichDrumLib;
7171 _drumstaff.whichDrumLib = cmper;
7181#ifdef PDK_FRAMEWORK_DEBUG
7190#ifdef PDK_FRAMEWORK_PREFS
7203#ifndef DOXYGEN_SHOULD_IGNORE_THIS
7209 EDTNamePos _namepos;
7212 bool LoadFirst()
override {
return false; }
7215 int DataSizeLoad()
const override {
return sizeof(EDTNamePos); }
7216 void*
Allocate()
override {
return (
void*) &_namepos; }
7233 const char*
ClassName()
const override {
return "FCStaffNamePosition"; }
7236#ifndef DOXYGEN_SHOULD_IGNORE_THIS
7238 bool _GetFullNamePos() {
return _fullnamepos; }
7246 void* _GetDataPtr() {
return &_namepos; }
7249 bool Load(CMPER itemno)
override
7251 const EDTNamePos savenamepos = _namepos;
7256 _namepos = savenamepos;
7296 FLAG_16
GetAlignment()
const {
return (_namepos.flag & NAMEPOS_HALIGNBITS) >> 4; }
7334 const FLAG_16 actualJustiBits = (NAMEPOS_JUSTIBITS & 0x7);
7335 justification &= actualJustiBits;
7336 _namepos.flag &= ~actualJustiBits;
7337 _namepos.flag |= justification;
7348 alignment = alignment << 4;
7349 alignment &= NAMEPOS_HALIGNBITS;
7350 _namepos.flag &= ~NAMEPOS_HALIGNBITS;
7351 _namepos.flag |= alignment;
7360 Set16BitFlag(&_namepos.flag, NAMEPOS_EXPAND_SINGLE_WORD, state);
7397#ifndef DOXYGEN_SHOULD_IGNORE_THIS
7398#ifdef PDK_FRAMEWORK_PREFS
7400 std::unique_ptr<FCStaffNamePosition> _pFullNamePosition;
7401 std::unique_ptr<FCStaffNamePosition> _pAbbreviatedNamePosition;
7410 EVERSION _VersionToUse()
const;
7419 virtual const uonebyte* _GetInstUUIDPtr()
const = 0;
7422 virtual const FLAG_16* _GetInstFlagPtr()
const = 0;
7425 virtual const FLAG_16* _GetFlagPtr()
const = 0;
7428 virtual const FLAG_16* _GetAltFlagPtr()
const = 0;
7431 virtual const FLAG_16* _GetAltFlag2Ptr()
const = 0;
7434 virtual const twobyte* _GetTranspositionPtr()
const = 0;
7437 virtual const FLAG_16* _GetMoreFlagsPtr()
const = 0;
7440 virtual const FLAG_16* _GetMoreFlags2Ptr()
const = 0;
7443 virtual const FLAG_16* _GetMoreFlags3Ptr()
const = 0;
7446 virtual const twobyte* _GetAbbrvNamePtr()
const = 0;
7449 virtual const twobyte* _GetFullNamePtr()
const = 0;
7452 virtual const twobyte* _GetClefsPtr()
const = 0;
7455 virtual const Efix32* _GetVertTabNumOffPtr()
const = 0;
7458 virtual const CMPER* _GetFretInstIDPtr()
const = 0;
7461 virtual const Evpu16* _GetBottomBarlineOffsetPtr()
const = 0;
7464 virtual const Evpu16* _GetTopBarlineOffsetPtr()
const = 0;
7467 virtual const utwobyte* _GetCapoLowFretPtr()
const = 0;
7470 virtual const FLAG_16* _GetBotLinesPtr()
const = 0;
7473 virtual const FLAG_16* _GetTopLinesPtr()
const = 0;
7476 virtual const Efix32* _GetLineSpacePtr()
const = 0;
7479 virtual const twobyte* _GetDwWRestPtr()
const = 0;
7482 virtual const twobyte* _GetStemReversalPtr()
const = 0;
7485 virtual const twobyte* _GetRepeatDotsOffPtr()
const = 0;
7488 virtual const twobyte* _GetHOtherRestPtr()
const = 0;
7491 virtual const EFONTID* _GetMFontPtr()
const = 0;
7494 virtual const twobyte* _GetSizeEfxPtr()
const = 0;
7497 virtual const Efix32* _GetHorzStemOffUpPtr()
const = 0;
7500 virtual const Efix32* _GetHorzStemOffDownPtr()
const = 0;
7503 virtual const Efix32* _GetVertStemStartOffUpPtr()
const = 0;
7506 virtual const Efix32* _GetVertStemStartOffDownPtr()
const = 0;
7509 virtual const Efix32* _GetVertStemEndOffUpPtr()
const = 0;
7512 virtual const Efix32* _GetVertStemEndOffDownPtr()
const = 0;
7518 virtual EXTAG _GetFullNamePosTag()
const = 0;
7524 virtual twobyte _GetFullNamePosCmper()
const = 0;
7530 virtual EXTAG _GetAbbreviatedNamePosTag()
const = 0;
7536 virtual twobyte _GetAbbreviatedNamePosCmper()
const = 0;
7538#ifdef PDK_FRAMEWORK_PREFS
7543 virtual bool _SaveNewFullNamePos() = 0;
7549 virtual bool _SaveNewAbbreviatedNamePos() = 0;
7557 void _SetFlag(FLAG_16 mask,
bool state)
7559 FLAG_16* pFlag = (FLAG_16*) _GetFlagPtr();
7569 bool _GetInstFlag(FLAG_16 mask)
const
7576 void _SetInstFlag(FLAG_16 mask,
bool state)
7578 FLAG_16* pInstFlag = (FLAG_16*) _GetInstFlagPtr();
7586 bool _GetFlag(FLAG_16 mask)
const
7595 bool _GetAltFlag(FLAG_16 mask)
const
7604 void _SetAltFlag(FLAG_16 mask,
bool state)
7606 FLAG_16* pFlag = (FLAG_16*) _GetAltFlagPtr();
7614 bool _GetTranspositionFlag(FLAG_16 mask)
const
7616 return GetBitFlag(*_GetTranspositionPtr(), mask);
7623 void _SetTranspositionFlag(FLAG_16 mask,
bool state)
7625 FLAG_16* pFlag = (FLAG_16*) _GetTranspositionPtr();
7633 bool _GetMoreFlags(FLAG_16 mask)
const
7635 return GetBitFlag(*_GetMoreFlagsPtr(), mask);
7638 bool _GetMoreFlags2(FLAG_16 mask)
const
7640 return GetBitFlag(*_GetMoreFlags2Ptr(), mask);
7643 bool _GetMoreFlags3(FLAG_16 mask)
const
7645 return GetBitFlag(*_GetMoreFlags3Ptr(), mask);
7652 void _SetMoreFlags(FLAG_16 mask,
bool state)
7654 FLAG_16* pFlag = (FLAG_16*) _GetMoreFlagsPtr();
7662 void _SetMoreFlags2(FLAG_16 mask,
bool state)
7664 FLAG_16* pFlag = (FLAG_16*) _GetMoreFlags2Ptr();
7672 void _SetMoreFlags3(FLAG_16 mask,
bool state)
7674 FLAG_16* pFlag =
const_cast<FLAG_16*
>(_GetMoreFlags3Ptr());
7679 void _SetAbbreviatedNameID(CMPER cmperid)
7681 CMPER* pCmper = (CMPER*) _GetAbbrvNamePtr();
7686 void _SetFullNameID(CMPER cmperid)
7688 CMPER* pCmper = (CMPER*) _GetFullNamePtr();
7693 const char*
ClassName()
const override {
return "__FCStaffBase"; }
7695#if FXT_VERSION >= FINALEVERSION_2012
9386 bool Save()
override;
9437#if FXT_VERSION < FINALEVERSION_25
9438 return !_GetInstFlag(STAFF_NEGTIME);
9440 return !_GetInstFlag(STAFF_NEGTIME_SCORE);
9470#if FXT_VERSION >= FINALEVERSION_25
9471 return !_GetMoreFlags3(STAFF_MF3_NEGTIME_PARTS);
9597 return !
GetBitFlag(*_GetFlagPtr(), STAFF_HIDE_REPEAT_TOP_DOT);
9607 return !
GetBitFlag(*_GetFlagPtr(), STAFF_HIDE_REPEAT_BOTTOM_DOT);
9677#ifndef PDK_FRAMEWORK_LUAFRIENDLY
9684 switch(*_GetMoreFlagsPtr() & STAFF_MF_STEM_DIR_MASK)
9686 case STAFF_MF_STEM_DIR_ALWAYS_UP:
9688 case STAFF_MF_STEM_DIR_ALWAYS_DOWN:
9690 case STAFF_MF_STEM_DIR_DEFAULT:
9759 bool GetShowTies()
const {
return _GetMoreFlags(STAFF_MF_SHOW_TIES); }
9768 return _GetAltFlag(STAFF_ALT_SHOWOTHERNOTES);
9797 return _GetMoreFlags(STAFF_MF_SHOW_TUPLETS);
9806 return _GetMoreFlags(STAFF_MF_CLEF_FIRST_MEAS_ONLY);
9815 return _GetMoreFlags(STAFF_MF_USE_TAB_LETTERS);
9824 return _GetMoreFlags(STAFF_MF_BREAK_LINES_AT_NOTES);
9838#ifndef PDK_FRAMEWORK_LUAFRIENDLY
9893 return *_GetLineSpacePtr();
9900#ifndef PDK_FRAMEWORK_LUAFRIENDLY
9911 return ((*_GetAltFlagPtr() & STAFF_ALTLAYER) >> 4) + 1;
10005#ifndef PDK_FRAMEWORK_LUAFRIENDLY
10020 const FLAG_16 *pMoreFlags3 = _GetMoreFlags3Ptr();
10021 if ( !pMoreFlags3 )
return false;
10022 return (_GetMoreFlags3(0x0001 ));
10033 const FLAG_16 *pMoreFlags2 = _GetMoreFlags2Ptr();
10034 if ( !pMoreFlags2 )
return false;
10035 return (_GetMoreFlags2(0x0001 ));
10060#ifdef PDK_FRAMEWORK_PREFS
10096 return LOBYTE(*_GetCapoLowFretPtr());
10105 return HIBYTE(*_GetCapoLowFretPtr());
10117 return *_GetVertTabNumOffPtr();
10127 return *_GetFretInstIDPtr();
10137 return *_GetBottomBarlineOffsetPtr();
10147 return *_GetTopBarlineOffsetPtr();
10150#if FXT_VERSION >= FINALEVERSION_2012
10163 if (_VersionToUse() < FINALEVERSION_2012)
return "";
10166 const uonebyte* pInstUUID = _GetInstUUIDPtr();
10167 for (
int i = 0; i < UUID_SIZE_PDK; i++)
10169 uonebyte abyte = pInstUUID[i];
10170 int highnibble = (abyte & 0xf0) >> 4;
10171 int lownibble = (abyte & 0x0f);
10172 if (highnibble < 10)
10176 if (lownibble < 10)
10247#if FXT_VERSION < FINALEVERSION_25
10248 _SetInstFlag(STAFF_NEGTIME, !value);
10250 _SetInstFlag(STAFF_NEGTIME_SCORE, !value);
10263#if FXT_VERSION >= FINALEVERSION_25
10264 _SetMoreFlags3(STAFF_MF3_NEGTIME_PARTS, !value);
10352 *
const_cast<twobyte*
>(_GetHOtherRestPtr()) = MAKE_TWOBYTE(position, HI_ONEBYTE(*_GetHOtherRestPtr()));
10362 *
const_cast<twobyte*
>(_GetHOtherRestPtr()) = MAKE_TWOBYTE(LO_ONEBYTE(*_GetHOtherRestPtr()), position);
10372 *
const_cast<twobyte*
>(_GetDwWRestPtr()) = MAKE_TWOBYTE(LO_ONEBYTE(*_GetDwWRestPtr()), position);
10382 *
const_cast<twobyte*
>(_GetDwWRestPtr()) = MAKE_TWOBYTE(position, HI_ONEBYTE(*_GetDwWRestPtr()));
10392 twobyte* pStemReversal = (twobyte*) _GetStemReversalPtr();
10393 *pStemReversal = position;
10403 Set16BitFlag((FLAG_16*)_GetFlagPtr(), STAFF_HIDE_REPEAT_TOP_DOT, !state);
10413 Set16BitFlag((FLAG_16*)_GetFlagPtr(), STAFF_HIDE_REPEAT_BOTTOM_DOT, !state);
10422 { *
const_cast<twobyte*
>(_GetRepeatDotsOffPtr()) = MAKE_TWOBYTE(LO_ONEBYTE(*_GetRepeatDotsOffPtr()), position); }
10430 { *
const_cast<twobyte*
>(_GetRepeatDotsOffPtr()) = MAKE_TWOBYTE(position, HI_ONEBYTE(*_GetRepeatDotsOffPtr())); }
10499#ifndef PDK_FRAMEWORK_LUAFRIENDLY
10510 mask = STAFF_MF_STEM_DIR_ALWAYS_UP;
10513 mask = STAFF_MF_STEM_DIR_ALWAYS_DOWN;
10517 mask = STAFF_MF_STEM_DIR_DEFAULT;
10520 *
const_cast<FLAG_16*
>(_GetMoreFlagsPtr()) = (*_GetMoreFlagsPtr() & ~STAFF_MF_STEM_DIR_MASK) | mask;
10586 void SetShowTies(
bool state) { _SetMoreFlags(STAFF_MF_SHOW_TIES, state); }
10594 _SetAltFlag(STAFF_ALT_SHOWOTHERNOTES, state);
10623 _SetMoreFlags(STAFF_MF_SHOW_TUPLETS, state);
10632 _SetMoreFlags(STAFF_MF_CLEF_FIRST_MEAS_ONLY, state);
10641 _SetMoreFlags(STAFF_MF_USE_TAB_LETTERS, state);
10650 _SetMoreFlags(STAFF_MF_BREAK_LINES_AT_NOTES, state);
10662#ifndef PDK_FRAMEWORK_LUAFRIENDLY
10672 _SetFlag(STAFF_DOPERCUSSIONNOTES,
true);
10673 _SetFlag(STAFF_TABNOTES,
false);
10676 _SetFlag(STAFF_DOPERCUSSIONNOTES,
false);
10677 _SetFlag(STAFF_TABNOTES,
true);
10680 _SetFlag(STAFF_DOPERCUSSIONNOTES,
false);
10681 _SetFlag(STAFF_TABNOTES,
false);
10760 Efix32* pStorage = (Efix32*) _GetLineSpacePtr();
10761 *pStorage = (distance / 64) * 64;
10771#ifndef PDK_FRAMEWORK_LUAFRIENDLY
10778 FLAG_16* pAltFlag = (FLAG_16*)_GetAltFlagPtr();
10779 *pAltFlag &= ~STAFF_ALTNOTATION;
10780 *pAltFlag |= value;
10791 if (value < 1)
return;
10792 if (value > FX_GetMaxLayers())
return;
10794 value = value << 4;
10795 FLAG_16* pAltFlag = (FLAG_16*) _GetAltFlagPtr();
10796 *pAltFlag &= ~STAFF_ALTLAYER;
10797 *pAltFlag |= value;
10877#ifndef PDK_FRAMEWORK_LUAFRIENDLY
10894 clefindex &= 0x00ff;
10895 clefindex *= 0x100;
10896 twobyte* pClefs = (twobyte*)_GetClefsPtr();
10898 *pClefs |= clefindex;
10908 twobyte* pClefs = (twobyte*) _GetClefsPtr();
10910 *pClefs |= clefindex;
10921 const FLAG_16 *pMoreFlags3 = _GetMoreFlags3Ptr();
10922 if ( !pMoreFlags3 )
return;
10923 _SetMoreFlags3(0x0001 ,state);
10934 const FLAG_16 *pMoreFlags2 = _GetMoreFlags2Ptr();
10935 if ( !pMoreFlags2 )
return;
10936 _SetMoreFlags2(0x0001 ,state);
10945 BYTE lobyte = LOBYTE(*_GetCapoLowFretPtr());
10946 utwobyte* pCapoLowFret = (utwobyte*) _GetCapoLowFretPtr();
10947 *pCapoLowFret = MAKEWORD(lobyte, value);
10958 BYTE hibyte = HIBYTE(*_GetCapoLowFretPtr());
10959 utwobyte* pCapoLowFret = (utwobyte*) _GetCapoLowFretPtr();
10960 *pCapoLowFret = MAKEWORD(value, hibyte);
10972 Efix32* pVertTabNumOff = (Efix32*) _GetVertTabNumOffPtr();
10973 *pVertTabNumOff = value;
10984 CMPER* pFretInstID = (CMPER*) _GetFretInstIDPtr();
10985 *pFretInstID = newid;
10995 Evpu16* pData = (Evpu16*) _GetBottomBarlineOffsetPtr();
11006 Evpu16* pData = (Evpu16*) _GetTopBarlineOffsetPtr();
11010#if FXT_VERSION >= FINALEVERSION_2012
11027 if (_VersionToUse() < FINALEVERSION_2012)
return;
11028 if (!pszUUID)
return;
11029 if (strlen(pszUUID) != 36)
return;
11030 if (pszUUID[8] !=
'-')
return;
11031 if (pszUUID[13] !=
'-')
return;
11032 if (pszUUID[18] !=
'-')
return;
11033 if (pszUUID[23] !=
'-')
return;
11034 for (
int i = 0; i < 36; i++)
11042 if (pszUUID[i] !=
'-')
return;
11045 if ((pszUUID[i] >=
'a') && (pszUUID[i] <=
'f'))
break;
11046 if ((pszUUID[i] >=
'0') && (pszUUID[i] <=
'9'))
break;
11051 const char* pszCurrent = pszUUID;
11052 for (
int i = 0; i < UUID_SIZE_PDK; i++)
11054 int result1, result2;
11055 if (*pszCurrent >=
'a') result1 = *pszCurrent -
'a' + 10;
11056 else if (*pszCurrent >=
'A') result1 = *pszCurrent -
'A' + 10;
11057 else result1 = *pszCurrent -
'0';
11059 if (*pszCurrent >=
'a') result2 = *pszCurrent -
'a' + 10;
11060 else if (*pszCurrent >=
'A') result2 = *pszCurrent -
'A' + 10;
11061 else result2 = *pszCurrent -
'0';
11062 int result = (result1 * 0x10) | result2;
11063 uonebyte* pInstUUID = (uonebyte*) _GetInstUUIDPtr();
11064 pInstUUID[i] = result;
11066 if ((i == 3) || (i == 5) || (i == 7) || (i == 9)) pszCurrent ++;
11081 _SetFlag(STAFF_DOPERCUSSIONNOTES,
false);
11082 _SetFlag(STAFF_TABNOTES,
false);
11123 return ((*_GetTranspositionPtr() & ~STAFF_NOKEYOPT) != 0);
11277 retval->
SetSize(HIBYTE(*_GetSizeEfxPtr()));
11283#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
11285 luabridge::RefCountedPtr<FCFontInfo> CreateIndependentFontInfo_GC()
const
11296 *
const_cast<EFONTID*
>(_GetMFontPtr()) = font.
GetIDByName();
11310#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
11312 luabridge::RefCountedPtr<FCString> CreateFullNameString_GC()
11326#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
11328 luabridge::RefCountedPtr<FCString> CreateAbbreviatedNameString_GC()
11332#ifdef PDK_FRAMEWORK_ENIGMASTRINGS
11350#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
11352 luabridge::RefCountedPtr<FCString> CreateDisplayFullNameString_GC()
11371#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
11373 luabridge::RefCountedPtr<FCString> CreateDisplayAbbreviatedNameString_GC()
11387#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
11389 luabridge::RefCountedPtr<FCString> CreateTrimmedFullNameString_GC()
11403#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
11405 luabridge::RefCountedPtr<FCString> CreateTrimmedAbbreviatedNameString_GC()
11412#if FXT_VERSION >= FINALEVERSION_2012
11424 if (_VersionToUse() < FINALEVERSION_2012)
return false;
11425 uonebyte* pInstUUID = (uonebyte*) _GetInstUUIDPtr();
11427 if (strlen(pszUUID) != 36)
return false;
11428 if (pszUUID[8] !=
'-')
return false;
11429 if (pszUUID[13] !=
'-')
return false;
11430 if (pszUUID[18] !=
'-')
return false;
11431 if (pszUUID[23] !=
'-')
return false;
11432 const char* pszCurrent = pszUUID;
11433 for (
int i = 0; i < UUID_SIZE_PDK; i++)
11435 int result1, result2;
11436 if (*pszCurrent >=
'a') result1 = *pszCurrent -
'a' + 10;
11437 else if (*pszCurrent >=
'A') result1 = *pszCurrent -
'A' + 10;
11438 else result1 = *pszCurrent -
'0';
11440 if (*pszCurrent >=
'a') result2 = *pszCurrent -
'a' + 10;
11441 else if (*pszCurrent >=
'A') result2 = *pszCurrent -
'A' + 10;
11442 else result2 = *pszCurrent -
'0';
11443 int result = (result1 * 0x10) | result2;
11444 if (result != pInstUUID[i])
return false;
11446 if ((i == 3) || (i == 5) || (i == 7) || (i == 9)) pszCurrent ++;
11452#if FXT_VERSION >= FINALEVERSION_2012
11467 if (_VersionToUse() < FINALEVERSION_2012)
return false;
11468 uonebyte* pInstUUID = (uonebyte*) _GetInstUUIDPtr();
11469 bool blockisempty =
true;
11470 for (
int i = 0; i < UUID_SIZE_PDK; i++)
if (pInstUUID[i]) blockisempty =
false;
11471 if (blockisempty)
return false;
11483#if FXT_VERSION >= FINALEVERSION_2012
11484#define PROTECTED2012STAFFSPEC(code) code
11486#define PROTECTED2012STAFFSPEC(code)
11490#if FXT_VERSION >= FINALEVERSION_2014
11491#define PROTECTED2014STAFFSPEC(code) code
11493#define PROTECTED2014STAFFSPEC(code)
11504 const bool _skipWorkaround;
11506 void _InitEDTStructs()
11509 switch (_VersionToUse())
11511 case FINALEVERSION_2010:
11512 size =
sizeof(_staffspec2010);
11513 memset(&_staffspec2010, 0, size);
11515 case FINALEVERSION_2012:
11516 PROTECTED2012STAFFSPEC(size =
sizeof(_staffspec2012);)
11517 PROTECTED2012STAFFSPEC(memset(&_staffspec2012, 0, size));
11520 PROTECTED2014STAFFSPEC(size =
sizeof(_staffspec2014);)
11521 PROTECTED2014STAFFSPEC(memset(&_staffspec2014, 0, size));
11527#ifndef DOXYGEN_SHOULD_IGNORE_THIS
11534 EDTStaffSpec2010 _staffspec2010;
11535 PROTECTED2012STAFFSPEC(EDTStaffSpec2012 _staffspec2012;)
11536 PROTECTED2014STAFFSPEC(EDTStaffSpec2014 _staffspec2014;)
11538 EXTAG
Tag()
const override {
return ot_EDTStaffSpec; }
11541 switch (_VersionToUse())
11543 case FINALEVERSION_2010:
11544 return sizeof(EDTStaffSpec2010);
11545 case FINALEVERSION_2012:
11546 PROTECTED2012STAFFSPEC(
return sizeof(EDTStaffSpec2012));
11549 PROTECTED2014STAFFSPEC(
return sizeof(EDTStaffSpec2014));
11555 switch (_VersionToUse())
11557 case FINALEVERSION_2010:
11558 return (
void*) &_staffspec2010;
11559#if FXT_VERSION >= FINALEVERSION_2012
11560 case FINALEVERSION_2012:
11561 return (
void*) &_staffspec2012;
11564 PROTECTED2014STAFFSPEC(
return (
void*) &_staffspec2014);
11575 void* pStaffSpec = NULL;
11577 switch (_VersionToUse())
11579 case FINALEVERSION_2010:
11580 pStaffSpec = &_staffspec2010;
11581 size =
sizeof(_staffspec2010);
11583 case FINALEVERSION_2012:
11584 PROTECTED2012STAFFSPEC(
11585 pStaffSpec = &_staffspec2012;
11586 size =
sizeof(_staffspec2012);)
11589 PROTECTED2014STAFFSPEC(
11590 pStaffSpec = &_staffspec2014;
11591 size =
sizeof(_staffspec2014);)
11595 memcpy(pStaffSpec, ((
FCStaff*)pSource)->_GetStaffSpec(), size);
11604 const uonebyte* _GetInstUUIDPtr()
const override
11606 if (_VersionToUse() >= FINALEVERSION_2014)
11607 return _staffspec2014.instUUID;
11608 if (_VersionToUse() >= FINALEVERSION_2012)
11609 return _staffspec2012.instUUID;
11614 const FLAG_16* _GetInstFlagPtr()
const override
11616 return &((EDTStaffSpec2010*)_GetStaffSpec())->instflag;
11620 const FLAG_16* _GetFlagPtr()
const override
11622 return &((EDTStaffSpec2010*)_GetStaffSpec())->flag;
11626 const FLAG_16* _GetAltFlagPtr()
const override
11628 return &((EDTStaffSpec2010*)_GetStaffSpec())->altFlag;
11632 const FLAG_16* _GetAltFlag2Ptr()
const override
11634 return &((EDTStaffSpec2010*)_GetStaffSpec())->altFlag2;
11638 const twobyte* _GetTranspositionPtr()
const override
11640 return &((EDTStaffSpec2010*)_GetStaffSpec())->transposition;
11644 const FLAG_16* _GetMoreFlagsPtr()
const override
11646 return &((EDTStaffSpec2010*)_GetStaffSpec())->moreFlags;
11650 const FLAG_16* _GetMoreFlags2Ptr()
const override
11652 if (_VersionToUse() < FINALEVERSION_2014)
return NULL;
11653#if FXT_VERSION < FINALEVERSION_25
11654 return (
const FLAG_16*)&((EDTStaffSpec2014*)_GetStaffSpec())->hideKeySigsShowAccis;
11656 return &((EDTStaffSpec2014*)_GetStaffSpec())->moreFlags2;
11661 const FLAG_16* _GetMoreFlags3Ptr()
const override
11663 if (_VersionToUse() < FINALEVERSION_2014)
return NULL;
11664#if FXT_VERSION < FINALEVERSION_25
11665 return (
const FLAG_16*) &((EDTStaffSpec2014*)_GetStaffSpec())->redisplayLayerAccis;
11667 return &((EDTStaffSpec2014*)_GetStaffSpec())->moreFlags3;
11672 FLAG_16* _GetAutoNumPtr()
const
11674 if (_VersionToUse() < FINALEVERSION_2012)
return NULL;
11675 if (_VersionToUse() < FINALEVERSION_2014)
11676 return (FLAG_16*)&((EDTStaffSpec2012*)_GetStaffSpec())->autoNum;
11677 return (FLAG_16*)&((EDTStaffSpec2014*)_GetStaffSpec())->autoNum;
11681 const twobyte* _GetAbbrvNamePtr()
const override
11683 return &((EDTStaffSpec2010*)_GetStaffSpec())->abbrvName;
11687 const twobyte* _GetFullNamePtr()
const override
11689 return &((EDTStaffSpec2010*)_GetStaffSpec())->fullName;
11693 const twobyte* _GetClefsPtr()
const override
11695 return &((EDTStaffSpec2010*)_GetStaffSpec())->clefs;
11699 const Efix32* _GetVertTabNumOffPtr()
const override
11701 return &((EDTStaffSpec2010*)_GetStaffSpec())->vertTabNumOff;
11705 const CMPER* _GetFretInstIDPtr()
const override
11707 return &((EDTStaffSpec2010*)_GetStaffSpec())->fretInstID;
11711 const Evpu16* _GetBottomBarlineOffsetPtr()
const override
11713 return &((EDTStaffSpec2010*)_GetStaffSpec())->botBarlineOffset;
11717 const Evpu16* _GetTopBarlineOffsetPtr()
const override
11719 return &((EDTStaffSpec2010*)_GetStaffSpec())->topBarlineOffset;
11723 const utwobyte* _GetCapoLowFretPtr()
const override
11725 return &((EDTStaffSpec2010*)_GetStaffSpec())->capoLowFret;
11729 const FLAG_16* _GetBotLinesPtr()
const override
11731 return &((EDTStaffSpec2010*)_GetStaffSpec())->botLines;
11735 const FLAG_16* _GetTopLinesPtr()
const override
11737 return &((EDTStaffSpec2010*)_GetStaffSpec())->topLines;
11741 const Efix32* _GetLineSpacePtr()
const override
11743 return &((EDTStaffSpec2010*)_GetStaffSpec())->lineSpace;
11747 const twobyte* _GetDwWRestPtr()
const override
11749 return &((EDTStaffSpec2010*)_GetStaffSpec())->dw_wRest;
11753 const twobyte* _GetStemReversalPtr()
const override
11755 return &((EDTStaffSpec2010*)_GetStaffSpec())->stemReversal;
11759 const twobyte* _GetRepeatDotsOffPtr()
const override
11761 return &((EDTStaffSpec2010*)_GetStaffSpec())->repeatDotsOff;
11765 const twobyte* _GetHOtherRestPtr()
const override
11767 return &((EDTStaffSpec2010*)_GetStaffSpec())->h_otherRest;
11771 const ETAG* _GetFullNamePosTagPtr()
const
11773 return &((EDTStaffSpec2010*)_GetStaffSpec())->fullNamePosTag;
11777 const twobyte* _GetFullNamePosCmperPtr()
const
11779 return &((EDTStaffSpec2010*)_GetStaffSpec())->fullNamePosCmper;
11783 const ETAG* _GetAbbrvNamePosTagPtr()
const
11785 return &((EDTStaffSpec2010*)_GetStaffSpec())->abbrvNamePosTag;
11789 const EFONTID* _GetMFontPtr()
const override
11791 return &((EDTStaffSpec2010*)_GetStaffSpec())->mfont;
11795 const twobyte* _GetSizeEfxPtr()
const override
11797 return &((EDTStaffSpec2010*)_GetStaffSpec())->sizeefx;
11801 const Efix32* _GetHorzStemOffUpPtr()
const override
11803 return &((EDTStaffSpec2010*)_GetStaffSpec())->horzStemOffUp;
11807 const Efix32* _GetHorzStemOffDownPtr()
const override
11809 return &((EDTStaffSpec2010*)_GetStaffSpec())->horzStemOffDown;
11813 const Efix32* _GetVertStemStartOffUpPtr()
const override
11815 return &((EDTStaffSpec2010*)_GetStaffSpec())->vertStemStartOffUp;
11819 const Efix32* _GetVertStemStartOffDownPtr()
const override
11821 return &((EDTStaffSpec2010*)_GetStaffSpec())->vertStemStartOffDown;
11825 const Efix32* _GetVertStemEndOffUpPtr()
const override
11827 return &((EDTStaffSpec2010*)_GetStaffSpec())->vertStemEndOffUp;
11831 const Efix32* _GetVertStemEndOffDownPtr()
const override
11833 return &((EDTStaffSpec2010*)_GetStaffSpec())->vertStemEndOffDown;
11837 const twobyte* _GetAbbrvNamePosCmperPtr()
const {
return &((EDTStaffSpec2010*)_GetStaffSpec())->abbrvNamePosCmper; }
11843 EXTAG _GetFullNamePosTag()
const override
11844 {
return (ufourbyte)( ((ufourbyte)edOther<<16) | (ufourbyte)*_GetFullNamePosTagPtr() ); }
11850 twobyte _GetFullNamePosCmper()
const override {
return *_GetFullNamePosCmperPtr(); }
11856 EXTAG _GetAbbreviatedNamePosTag()
const override
11857 {
return (ufourbyte)( ((ufourbyte)edOther<<16) | (ufourbyte)*_GetAbbrvNamePosTagPtr() ); }
11863 twobyte _GetAbbreviatedNamePosCmper()
const override {
return *_GetAbbrvNamePosCmperPtr(); }
11865#ifdef PDK_FRAMEWORK_PREFS
11867 virtual bool _SaveNewFullNamePos()
override
11869 if (!_pFullNamePosition || !_pFullNamePosition->SaveNew())
return false;
11870 ((EDTStaffSpec2010*)_GetStaffSpec())->fullNamePosCmper = _pFullNamePosition->GetItemNo();
11875 virtual bool _SaveNewAbbreviatedNamePos()
override
11877 if (!_pAbbreviatedNamePosition || !_pAbbreviatedNamePosition->SaveNew())
return false;
11878 ((EDTStaffSpec2010*)_GetStaffSpec())->abbrvNamePosCmper = _pAbbreviatedNamePosition->GetItemNo();
11884 bool _SaveRawFields()
const;
11889#ifndef DOXYGEN_SHOULD_IGNORE_THIS
11893 return _VersionToUse();
11901#ifndef DOXYGEN_SHOULD_IGNORE_THIS
11909 const void* _GetStaffSpec()
const
11911 switch (_VersionToUse())
11913 case FINALEVERSION_2010:
11914 return &_staffspec2010;
11915 case FINALEVERSION_2012:
11916 PROTECTED2012STAFFSPEC(
return &_staffspec2012);
11919 PROTECTED2014STAFFSPEC(
return &_staffspec2014);
11925#ifndef DOXYGEN_SHOULD_IGNORE_THIS
11934 bool Load(CMPER itemno)
override;
11940 bool Save()
override
11943 return _SaveRawFields();
11950 return _SaveRawFields();
11983 { _InitEDTStructs(); }
11985#ifdef PDK_FRAMEWORK_LUAFRIENDLY
11991 { _InitEDTStructs(); }
11994 static FCStaff* FCStaff_Lua(
void* ptr, lua_State* L)
11996 return _OneOptionalParamLuaConstructor<FCStaff, bool>(ptr, L);
12007#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
12012 luabridge::RefCountedPtr<FCInstrumentPlaybackData> CreateInstrumentPlaybackData_GC()
12023#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
12025 luabridge::RefCountedPtr<FCFretInstrumentDef> CreateFretInstrumentDef_GC()
12041 const FLAG_16 * pAutoNum = _GetAutoNumPtr();
12043 return GetBitFlag(*pAutoNum, PDK_STAFF_USE_AUTONUM_MASK);
12057#ifndef PDK_FRAMEWORK_LUAFRIENDLY
12064 const FLAG_16 * pAutoNum = _GetAutoNumPtr();
12080 FLAG_16 * pAutoNum = _GetAutoNumPtr();
12082 Set16BitFlag(pAutoNum, PDK_STAFF_USE_AUTONUM_MASK, state);
12096#ifndef PDK_FRAMEWORK_LUAFRIENDLY
12104 FLAG_16 * pAutoNum = _GetAutoNumPtr();
12107 *pAutoNum &= ~PDK_STAFF_AUTONUM_TYPE_MASK;
12108 *pAutoNum |= value;
12163#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
12168 luabridge::RefCountedPtr<FCInstrumentDef> CreateLayerInstrumentDef_GC(
int layer)
12172#ifdef PDK_FRAMEWORK_DEBUG
12182 DebugOutHex(
"topLines :", ((EDTStaffSpec2010*)_GetStaffSpec())->topLines);
12183 DebugOutHex(
"botLines :", ((EDTStaffSpec2010*)_GetStaffSpec())->botLines);
12184 DebugOutInt(
"drumStaffCmper: ", ((EDTStaffSpec2010*)_GetStaffSpec())->drumStaffCmper);
12207#ifndef DOXYGEN_SHOULD_IGNORE_THIS
12210 bool Load([[maybe_unused]]CMPER itemno)
override {
return false; }
12214 bool SaveAs([[maybe_unused]]CMPER itemno)
override {
return false; }
12218 bool SaveNew()
override {
return false; }
12226 EXTAG
Tag()
const override {
return ot_EDTCurrStaffSpec; }
12229 const char*
ClassName()
const override {
return "FCCurrentStaffSpec"; }
12231#ifdef PDK_FRAMEWORK_ENTRIES
12289#ifndef DOXYGEN_SHOULD_IGNORE_THIS
12291 EDTArticulationDefinition _articdefold;
12293#if FXT_VERSION >= FINALEVERSION_2012
12294#if FXT_VERSION >= FINALEVERSION_26
12295 typedef EDTArticulationDefinition25_6 CurrEDTArticulationDefinition;
12297 typedef EDTArticulationDefinition2012 CurrEDTArticulationDefinition;
12299 CurrEDTArticulationDefinition _articdefCurr;
12302 bool Use2012Version()
const;
12304 mutable EFONTNAME _mainsymbolfontname;
12305 mutable EFONTNAME _flippedsymbolfontname;
12307 const FLAG_16* _GetFlag1Ptr()
const;
12308 const FLAG_16* _GetFlag2Ptr()
const;
12309 const twobyte* _GetMainShapePtr()
const;
12310 const twobyte* _GetFlippedShapePtr()
const;
12311 const twobyte* _GetStartTopNotePtr()
const;
12312 const twobyte* _GetStartBotNotePtr()
const;
12313 const twobyte* _GetDurTopNotePtr()
const;
12314 const twobyte* _GetDurBotNotePtr()
const;
12315 const twobyte* _GetAmpTopNotePtr()
const;
12316 const twobyte* _GetAmpBotNotePtr()
const;
12317 const Evpu16* _GetDefaultVerticalPosPtr()
const;
12318 const Evpu16* _GetMainHandleVerticalOffsetPtr()
const;
12319 const Evpu16* _GetMainHandleHorizontalOffsetPtr()
const;
12320 const Evpu16* _GetFlippedHandleVerticalOffsetPtr()
const;
12321 const Evpu16* _GetFlippedHandleHorizontalOffsetPtr()
const;
12323 bool _GetFlag1State(FLAG_16 state)
const {
return GetBitFlag(*_GetFlag1Ptr(), state); }
12324 void _SetFlag1State(FLAG_16 flagbits,
bool state)
12326 FLAG_16* pData = (FLAG_16*) _GetFlag1Ptr();
12329 bool _GetFlag2State(FLAG_16 state)
const {
return GetBitFlag(*_GetFlag2Ptr(), state); }
12330 void _SetFlag2State(FLAG_16 flagbits,
bool state)
12332 FLAG_16* pData = (FLAG_16*) _GetFlag2Ptr();
12337 EXTAG
Tag()
const override {
return ot_ArticulationDefinition; }
12370 ARTPOS_MANUAL_POSITIONING,
12371 ARTPOS_AUTO_NOTESTEM,
12372 ARTPOS_ALWAYS_NOTE_SIDE,
12373 ARTPOS_ALWAYS_STEM_SIDE,
12374 ARTPOS_BELOW_ENTRY,
12375 ARTPOS_ABOVE_ENTRY,
12376 ARTPOS_ALWAYS_ON_STEM
12394 ARTSLURINT_AUTO_INOUT
12398 const char*
ClassName()
const override {
return "FCArticulationDef"; }
12401#ifndef DOXYGEN_SHOULD_IGNORE_THIS
12408 void* _GetArticDef() {
return Allocate(); }
12442#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
12444 luabridge::RefCountedPtr<FCFontInfo> CreateMainSymbolFontInfo_GC()
const
12457#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
12459 luabridge::RefCountedPtr<FCFontInfo> CreateFlippedSymbolFontInfo_GC()
const
12717#ifndef PDK_FRAMEWORK_LUAFRIENDLY
12784#ifndef PDK_FRAMEWORK_LUAFRIENDLY
12903 bool IsIdenticalTo(
const FCArticulationDef& compareWith,
bool playbackinfo,
bool positioningvalues,
bool positioningoptions,
bool defaultside)
const;
13047 if (Use2012Version())
13049#if FXT_VERSION >= FINALEVERSION_2012
13050 _articdefCurr.charMain = symbol;
13055 _articdefold.efxsymbolMain &= 0xff00;
13056 _articdefold.efxsymbolMain |= (symbol & 0xff);
13067 _SetFlag2State(ARTIC_MAIN_IS_SHAPE, useshape);
13077 _SetFlag2State(ARTIC_FLIPPED_IS_SHAPE, useshape);
13088 CMPER* pValue = (CMPER*) _GetMainShapePtr();
13100 CMPER* pValue = (CMPER*) _GetFlippedShapePtr();
13113 if (Use2012Version())
13115#if FXT_VERSION >= FINALEVERSION_2012
13116 _articdefCurr.charAlt = symbol;
13121 _articdefold.efxsymbolFlipped &= 0xff00;
13122 _articdefold.efxsymbolFlipped |= (symbol & 0xff);
13182 twobyte* pValue = (twobyte*) _GetStartTopNotePtr();
13192 twobyte* pValue = (twobyte*) _GetStartBotNotePtr();
13201#ifndef PDK_FRAMEWORK_LUAFRIENDLY
13233#ifndef PDK_FRAMEWORK_LUAFRIENDLY
13285 Evpu16* pValue = (Evpu16*) _GetDefaultVerticalPosPtr();
13296 Evpu16* pValue = (Evpu16*) _GetMainHandleVerticalOffsetPtr();
13307 Evpu16* pValue = (Evpu16*) _GetMainHandleHorizontalOffsetPtr();
13318 Evpu16* pValue = (Evpu16*) _GetFlippedHandleVerticalOffsetPtr();
13328 Evpu16* pValue = (Evpu16*) _GetFlippedHandleHorizontalOffsetPtr();
13339 twobyte* pValue = (twobyte*) _GetDurTopNotePtr();
13349 twobyte* pValue = (twobyte*) _GetDurBotNotePtr();
13365 twobyte* pValue = (twobyte*) _GetAmpTopNotePtr();
13375 twobyte* pValue = (twobyte*) _GetAmpBotNotePtr();
13393#ifdef PDK_FRAMEWORK_DEBUG
13418#ifndef DOXYGEN_SHOULD_IGNORE_THIS
13419 EDTMarkingCategory _categorydefold;
13421 friend struct __FCEDTMarkingCategoryRaw;
13423#if FXT_VERSION >= FINALEVERSION_2012
13424 EDTMarkingCategory2012 _categorydef2012;
13427 bool _Use2012Version()
const;
13429 const FLAG_16* _GetFlagPtr()
const
13431#if FXT_VERSION >= FINALEVERSION_2012
13432 if (_Use2012Version())
return &_categorydef2012.categoryFlags;
13434 return &_categorydefold.categoryFlags;
13437 const twobyte* _GetCatIDPtr()
const
13439#if FXT_VERSION >= FINALEVERSION_2012
13440 if (_Use2012Version())
return &_categorydef2012.catID;
13442 return &_categorydefold.catID;
13445 const twobyte* _GetCatTypePtr()
const
13447#if FXT_VERSION >= FINALEVERSION_2012
13448 if (_Use2012Version())
return &_categorydef2012.categoryType;
13450 return &_categorydefold.categoryType;;
13453 const twobyte* _GetStaffListPtr()
const
13455#if FXT_VERSION >= FINALEVERSION_2012
13456 if (_Use2012Version())
return &_categorydef2012.staffList;
13458 return &_categorydefold.staffList;
13461 const twobyte* _GetVertAlignPtr()
const
13463#if FXT_VERSION >= FINALEVERSION_2012
13464 if (_Use2012Version())
return &_categorydef2012.vertAlign;
13466 return &_categorydefold.vertAlign;
13469 const twobyte* _GetVertOffsetBaseLinePtr()
const
13471#if FXT_VERSION >= FINALEVERSION_2012
13472 if (_Use2012Version())
return &_categorydef2012.vertOffsetBaseline;
13474 return &_categorydefold.vertOffsetBaseline;
13477 const twobyte* _GetVertOffsetEntryPtr()
const
13479#if FXT_VERSION >= FINALEVERSION_2012
13480 if (_Use2012Version())
return &_categorydef2012.vertOffsetEntry;
13482 return &_categorydefold.vertOffsetEntry;
13485 const twobyte* _GetJustificationPtr()
const
13487#if FXT_VERSION >= FINALEVERSION_2012
13488 if (_Use2012Version())
return &_categorydef2012.justification;
13490 return &_categorydefold.justification;
13493 const twobyte* _GetHorzAlignPtr()
const
13495#if FXT_VERSION >= FINALEVERSION_2012
13496 if (_Use2012Version())
return &_categorydef2012.horzAlign;
13498 return &_categorydefold.horzAlign;
13501 const twobyte* _GetHorzOffsetPtr()
const
13503#if FXT_VERSION >= FINALEVERSION_2012
13504 if (_Use2012Version())
return &_categorydef2012.horzOffset;
13506 return &_categorydefold.horzOffset;
13509 const EEnigmaFont* _GetTextFontPtr()
const
13511#if FXT_VERSION >= FINALEVERSION_2012
13512 if (_Use2012Version())
return &_categorydef2012.textFont;
13514 return &_categorydefold.textFont;
13517 const EEnigmaFont* _GetMusicFontPtr()
const
13519#if FXT_VERSION >= FINALEVERSION_2012
13520 if (_Use2012Version())
return &_categorydef2012.musicFont;
13522 return &_categorydefold.musicFont;
13525 const EEnigmaFont* _GetNumberFontPtr()
const
13527#if FXT_VERSION >= FINALEVERSION_2012
13528 if (_Use2012Version())
return &_categorydef2012.numberFont;
13530 return &_categorydefold.numberFont;
13533 bool _GetFlagState(FLAG_16 state)
const
13535 FLAG_16* pValue = (FLAG_16*) _GetFlagPtr();
13539 void _SetFlagState(FLAG_16 mask,
bool state)
13541 FLAG_16* pValue = (FLAG_16*) _GetFlagPtr();
13553#ifndef DOXYGEN_SHOULD_IGNORE_THIS
13555 EXTAG
Tag()
const override {
return ot_MarkingCategory; }
13559#if FXT_VERSION >= FINALEVERSION_2012
13560 if (_Use2012Version())
return sizeof(EDTMarkingCategory2012);
13562 return sizeof(EDTMarkingCategory);
13567#if FXT_VERSION >= FINALEVERSION_2012
13568 if (_Use2012Version())
return (
void*) &_categorydef2012;
13570 return (
void*) &_categorydefold;
13591 if (_Use2012Version())
return FINALEVERSION_2012;
13592 return FINALEVERSION_2010;
13643 const char*
ClassName()
const override {
return "FCCategoryDef"; }
13646#ifndef DOXYGEN_SHOULD_IGNORE_THIS
13653 void* _GetCategoryDef() {
return Allocate(); }
13779 if (!pOtherCategory)
return false;
13780 if (pOtherCategory->
GetID() !=
GetID())
return false;
13781 if (*pOtherCategory->_GetFlagPtr() != *_GetFlagPtr())
return false;
13783 pOtherCategory->
GetName(&othername);
13795 return _GetFlagState(MC_BREAK_MMREST);
13804 return _GetFlagState(MC_USES_STAFF_LIST);
13817 return *_GetCatIDPtr();
13829#ifndef PDK_FRAMEWORK_LUAFRIENDLY
13852#ifndef PDK_FRAMEWORK_LUAFRIENDLY
13868 return *_GetStaffListPtr();
13880#if FXT_VERSION >= FINALEVERSION_2012
13881 if (_Use2012Version())
13905#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
13907 luabridge::RefCountedPtr<FCString> CreateName_GC()
13918#ifndef PDK_FRAMEWORK_LUAFRIENDLY
13947#ifndef PDK_FRAMEWORK_LUAFRIENDLY
13962#ifndef PDK_FRAMEWORK_LUAFRIENDLY
13979 return *_GetHorzOffsetPtr();
14035 EEnigmaFont* pFont = (EEnigmaFont*) _GetTextFontPtr();
14038 pFont->size = pInfo->
GetSize();
14052 EEnigmaFont* pFont = (EEnigmaFont*) _GetMusicFontPtr();
14055 pFont->size = pInfo->
GetSize();
14069 EEnigmaFont* pFont = (EEnigmaFont*) _GetNumberFontPtr();
14072 pFont->size = pInfo->
GetSize();
14085 twobyte* pStaffList = (twobyte*) _GetStaffListPtr();
14086 *pStaffList = value;
14103#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
14105 luabridge::RefCountedPtr<FCFontInfo> CreateTextFontInfo_GC()
14117 return _GetFlagState(MC_USER_CREATED);
14128 return GetID() == 7;
14229 if (!pString)
return;
14235 if (_Use2012Version())
14237#if FXT_VERSION >= FINALEVERSION_2012
14239 memcpy(_categorydef2012.name, tempstring._GetUnicodeBuffer(), (len + 1) * sizeof (eUniChar16));
14240 _categorydef2012.name[len] = 0;
14245 strcpy(_categorydefold.name, tempstring.
GetCString());
14257#ifndef PDK_FRAMEWORK_LUAFRIENDLY
14265 twobyte* pAlign = (twobyte*) _GetVertAlignPtr();
14266 *pAlign = (twobyte) value;
14281 _SetFlagState(MC_BREAK_MMREST, state);
14290 _SetFlagState(MC_USES_STAFF_LIST, state);
14299 twobyte* pData = (twobyte*) _GetCatIDPtr();
14310 twobyte* pVertOffsetBase = (twobyte*) _GetVertOffsetBaseLinePtr();
14311 *pVertOffsetBase = value;
14321 twobyte* pOffset = (twobyte*) _GetVertOffsetEntryPtr();
14331#ifndef PDK_FRAMEWORK_LUAFRIENDLY
14347 twobyte* pJustification = (twobyte*) _GetJustificationPtr();
14348 *pJustification = value;
14359 twobyte* pHorizontalOffset = (twobyte*) _GetHorzOffsetPtr();
14360 *pHorizontalOffset = value;
14369#ifndef PDK_FRAMEWORK_LUAFRIENDLY
14377 twobyte* pHorizAlign = (twobyte*) _GetHorzAlignPtr();
14378 *pHorizAlign = (twobyte) value;
14381#ifdef PDK_FRAMEWORK_DEBUG
14412#ifndef DOXYGEN_SHOULD_IGNORE_THIS
14413 EDTFreezeMeasures _freezemeasures;
14417#ifndef DOXYGEN_SHOULD_IGNORE_THIS
14419 EXTAG
Tag()
const override {
return ot_FreezeMeasures; }
14420 int DataSizeLoad()
const override {
return sizeof(EDTFreezeMeasures); }
14421 void*
Allocate()
override {
return (
void*) &_freezemeasures; }
14431 memcpy(&_freezemeasures, ((
FCFreezeSystem*)pSource)->_GetFreezeMeasures(),
sizeof(_freezemeasures));
14439 bool LoadFirst()
override {
return false; }
14443 const char*
ClassName()
const override {
return "FCFreezeSystem"; }
14446#ifndef DOXYGEN_SHOULD_IGNORE_THIS
14453 void* _GetFreezeMeasures() {
return Allocate(); }
14462 memset(&_freezemeasures, 0,
sizeof(_freezemeasures));
14463 _freezemeasures.mode = 1;
14488#ifdef PDK_FRAMEWORK_DEBUG
14497#ifndef DOXYGEN_SHOULD_IGNORE_THIS
14499#define _EXP_NO_PLAYBACK 0x00
14500#define _EXP_MIDI_PERCUSSION_MAP 0x13
14501#define _EXP_SWING 0x0e
14502#define _EXP_HUMAN_PLAYBACK_ON 0x10
14503#define _EXP_HUMAN_PLAYBACK_OFF 0x11
14516#ifndef DOXYGEN_SHOULD_IGNORE_THIS
14517#if FXT_VERSION >= FINALEVERSION_2012
14518 typedef EDTTextExpression2012 CurrEDTTextExpression;
14520 typedef EDTTextExpression2004 CurrEDTTextExpression;
14522 CurrEDTTextExpression _nullexpression;
14525 CurrEDTTextExpression* _TypeCast()
const
14527 if (!
_datablock)
return (CurrEDTTextExpression*) &_nullexpression;
14531 void _AllocateMemory(
int size);
14533 EXTAG
Tag()
const override {
return ot_TextExpression; }
14645 const char*
ClassName()
const override {
return "FCTextExpressionDef"; }
14671 pEnclosure->
SaveAs(itemno);
14697#ifndef PDK_FRAMEWORK_LUAFRIENDLY
14714#ifndef PDK_FRAMEWORK_LUAFRIENDLY
14727 return GetBitFlag(_TypeCast()->flag, EXP_VALUEisEXEC);
14739 return _TypeCast()->value;
14751 _TypeCast()->value = shapeID;
14762 Set16BitFlag(&_TypeCast()->flag, EXP_VALUEisEXEC, state);
14771 return GetBitFlag(_TypeCast()->flag, TEXT_EXP_HIDEMEASURENUM);
14780 Set16BitFlag(&_TypeCast()->flag, TEXT_EXP_HIDEMEASURENUM, value);
14789 return GetBitFlag(_TypeCast()->flag, TEXT_EXP_NEWENCLOSURE);
14798 Set16BitFlag(&_TypeCast()->flag, TEXT_EXP_NEWENCLOSURE, value);
14815#if FXT_VERSION >= FINALEVERSION_2014
14816 return (_TypeCast()->category & 0x3fff);
14818 return (_TypeCast()->measYadjust & 0x3fff);
14837 if (!
GetBitFlag(_TypeCast()->flag, EXP_USEauxDATA))
return 0;
14839 return _TypeCast()->value;
14851 if (!
GetBitFlag(_TypeCast()->flag, EXP_USEauxDATA))
return 0;
14853 return _TypeCast()->auxdata1;
14864 return _TypeCast()->playPass;
14875 _TypeCast()->playPass = value;
14885 return _TypeCast()->value;
14896 if (value < 0) value = 0;
14897 if (value > 127) value = 127;
14899 _TypeCast()->value = value;
14907#ifndef PDK_FRAMEWORK_LUAFRIENDLY
14924#if FXT_VERSION >= FINALEVERSION_2014
14925 return _TypeCast()->yAdjustBaseline;
14927 return _TypeCast()->noteYadjustBaseline;
14938#if FXT_VERSION >= FINALEVERSION_2014
14939 return _TypeCast()->yAdjustEntry;
14941 return _TypeCast()->noteYadjustEntry;
14953#ifndef PDK_FRAMEWORK_LUAFRIENDLY
14971#ifndef PDK_FRAMEWORK_LUAFRIENDLY
14979 _TypeCast()->categorySpecific = value;
14989 return GetBitFlag(_TypeCast()->flag, TEXT_EXP_BREAKREST);
14999 Set16BitFlag(&_TypeCast()->flag, TEXT_EXP_BREAKREST, state);
15010#if FXT_VERSION >= FINALEVERSION_2014
15011 _TypeCast()->category &= 0xc000;
15012 _TypeCast()->category |= (ID & 0x3fff);
15014 _TypeCast()->measYadjust &= 0xc000;
15015 _TypeCast()->measYadjust |= (ID & 0x3fff);
15054 return _TypeCast()->value;
15067 return _TypeCast()->auxdata1;
15077 Set16BitFlag(&_TypeCast()->flag, EXP_USEauxDATA,
true);
15078 _TypeCast()->flag &= ~EXP_DYTYPEBITS;
15079 _TypeCast()->flag |= EXP_MIDI_CONTROLLER;
15080 _TypeCast()->value = value;
15081 _TypeCast()->auxdata1 = controllernumber;
15090 Set16BitFlag(&_TypeCast()->flag, EXP_USEauxDATA,
true);
15091 _TypeCast()->flag &= ~EXP_DYTYPEBITS;
15092 _TypeCast()->flag |= EXP_TIME;
15093 _TypeCast()->value = tempo;
15094 _TypeCast()->auxdata1 = eduduration;
15106 return _TypeCast()->value;
15119 _TypeCast()->value = halfsteps;
15133 return _TypeCast()->value - 8192;
15146 _TypeCast()->value = (std::min)((std::max)(0,
static_cast<int>(value) + 8192), 2*8192);
15155#ifndef PDK_FRAMEWORK_LUAFRIENDLY
15162 _TypeCast()->vertMeasExprAlign = (twobyte) value;
15172#if FXT_VERSION >= FINALEVERSION_2014
15173 _TypeCast()->yAdjustBaseline = value;
15175 _TypeCast()->noteYadjustBaseline = value;
15186#if FXT_VERSION >= FINALEVERSION_2014
15187 _TypeCast()->yAdjustEntry = value;
15189 _TypeCast()->noteYadjustEntry = value;
15200#ifndef PDK_FRAMEWORK_LUAFRIENDLY
15207#if FXT_VERSION >= FINALEVERSION_2014
15222#ifndef PDK_FRAMEWORK_LUAFRIENDLY
15229#if FXT_VERSION >= FINALEVERSION_2014
15230 _TypeCast()->horzExprAlign = (twobyte) value;
15232 _TypeCast()->measExprAlign = (twobyte) value;
15241#ifndef PDK_FRAMEWORK_LUAFRIENDLY
15248#if FXT_VERSION >= FINALEVERSION_2014
15261#ifndef PDK_FRAMEWORK_LUAFRIENDLY
15268#if FXT_VERSION >= FINALEVERSION_2014
15269 _TypeCast()->horzMeasExprAlign = (twobyte) value;
15271 _TypeCast()->measAlign = (twobyte) value;
15283 return _TypeCast()->measXadjust;
15293 _TypeCast()->measXadjust = value;
15306#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
15308 luabridge::RefCountedPtr<FCString> CreateTextString_GC()
15322#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
15324 luabridge::RefCountedPtr<FCEnclosure> CreateEnclosure_GC()
15456#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
15458 luabridge::RefCountedPtr<FCString> CreateDescription_GC()
15463#ifdef PDK_FRAMEWORK_DEBUG
15490#ifndef DOXYGEN_SHOULD_IGNORE_THIS
15493 EDTShapeExpression2004* _TypeCast()
const {
return (EDTShapeExpression2004*)
_datablock; }
15495 const char* _TypeCastTextPtr()
const
15503 void _AllocateMemory(
int size);
15507#ifndef DOXYGEN_SHOULD_IGNORE_THIS
15509 EXTAG
Tag()
const override {
15513 EVERSION
EnigmaVersion()
const override {
return _unicode ? FINALEVERSION_2012 : FINALEVERSION_2010; }
15527#ifndef DOXYGEN_SHOULD_IGNORE_THIS
15529 bool Load(CMPER cmper)
override;
15531 bool Save()
override;
15537 const char*
ClassName()
const override {
return "FCShapeExpressionDef"; }
15546 void* _GetShapeExpression() {
return Allocate(); }
15559#ifdef PDK_FRAMEWORK_SHAPES
15579#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
15582 luabridge::RefCountedPtr<FCShapeDef> CreateShapeDef_GC()
15595 return GetBitFlag(_TypeCast()->flag, EXP_VALUEisEXEC);
15605 return !
GetBitFlag(_TypeCast()->flag, SHAPE_EXP_LOCKDOWN);
15614 return GetBitFlag(_TypeCast()->flag, SHAPE_EXP_NOPRINT);
15623 return GetBitFlag(_TypeCast()->flag, SHAPE_EXP_BREAKMMREST);
15635 return _TypeCast()->value;
15644 return _TypeCast()->shapedef;
15654#ifndef PDK_FRAMEWORK_LUAFRIENDLY
15662#if FXT_VERSION >= FINALEVERSION_2014
15684#ifndef PDK_FRAMEWORK_LUAFRIENDLY
15691#if FXT_VERSION >= FINALEVERSION_2014
15704#if FXT_VERSION >= FINALEVERSION_2014
15705 return GetBitFlag(_TypeCast()->category, USE_CATEGORY_POS_MASK);
15706#elif FXT_VERSION >= FINALEVERSION_2012
15707 return GetBitFlag(_TypeCast()->measYadjust, USE_CATEGORY_POS_MASK);
15709 return GetBitFlag(_TypeCast()->measYadjust, 0x4000);
15720 return _TypeCast()->measXadjust;
15729#if FXT_VERSION < FINALEVERSION_2014
15730 return _TypeCast()->noteYadjustEntry;
15732 return _TypeCast()->yAdjustEntry;
15743#ifndef PDK_FRAMEWORK_LUAFRIENDLY
15759#if FXT_VERSION < FINALEVERSION_2014
15760 return _TypeCast()->noteYadjustBaseline;
15762 return _TypeCast()->yAdjustBaseline;
15779 _TypeCast()->shapedef = shapeID;
15792 _TypeCast()->value = shapeID;
15804 Set16BitFlag(&_TypeCast()->flag, EXP_VALUEisEXEC, state);
15813 Set16BitFlag(&_TypeCast()->flag, SHAPE_EXP_LOCKDOWN, !state);
15822 Set16BitFlag(&_TypeCast()->flag, SHAPE_EXP_NOPRINT, state);
15831 Set16BitFlag(&_TypeCast()->flag, SHAPE_EXP_BREAKMMREST, state);
15843#if FXT_VERSION >= FINALEVERSION_2014
15844 return (_TypeCast()->category & 0x3fff);
15846 return (_TypeCast()->measYadjust & 0x3fff);
15858#if FXT_VERSION >= FINALEVERSION_2014
15859 _TypeCast()->category &= 0xc000;
15860 _TypeCast()->category |= (ID & 0x3fff);
15862 _TypeCast()->measYadjust &= 0xc000;
15863 _TypeCast()->measYadjust |= (ID & 0x3fff);
15876#ifndef PDK_FRAMEWORK_LUAFRIENDLY
15884 twobyte setting = 0;
15897#if FXT_VERSION >= FINALEVERSION_2014
15898 _TypeCast()->horzExprAlign = (twobyte) setting;
15900 _TypeCast()->measExprAlign = (twobyte) setting;
15912#ifndef PDK_FRAMEWORK_LUAFRIENDLY
15919#if FXT_VERSION >= FINALEVERSION_2014
15920 _TypeCast()->horzMeasExprAlign = (twobyte) value;
15922 _TypeCast()->measAlign = (twobyte) value;
15932#if FXT_VERSION >= FINALEVERSION_2014
15933 Set16BitFlag((FLAG_16*) &_TypeCast()->category, USE_CATEGORY_POS_MASK, value);
15934#elif FXT_VERSION >= FINALEVERSION_2012
15935 Set16BitFlag((FLAG_16*) &_TypeCast()->measYadjust, USE_CATEGORY_POS_MASK, value);
15937 Set16BitFlag((FLAG_16*) &_TypeCast()->measYadjust, 0x4000, value);
15948 _TypeCast()->measXadjust = value;
15958#if FXT_VERSION < FINALEVERSION_2014
15959 _TypeCast()->noteYadjustEntry = value;
15961 _TypeCast()->yAdjustEntry = value;
15973#ifndef PDK_FRAMEWORK_LUAFRIENDLY
15980 _TypeCast()->vertMeasExprAlign = (twobyte) value;
15989#if FXT_VERSION < FINALEVERSION_2014
15990 _TypeCast()->noteYadjustBaseline = value;
15992 _TypeCast()->yAdjustBaseline = value;
16002#ifdef PDK_FRAMEWORK_SHAPES
16011 if (!pShapeDef)
return false;
16012 if (pShapeDef->
GetItemNo() < 1)
return false;
16013 _TypeCast()->shapedef = pShapeDef->
GetItemNo();
16026#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
16028 luabridge::RefCountedPtr<FCString> CreateDescription_GC()
16032#ifdef PDK_FRAMEWORK_DEBUG
16050#ifndef DOXYGEN_SHOULD_IGNORE_THIS
16051 EDTTextBlock2004 _textblock2004;
16052#if FXT_VERSION >= FINALEVERSION_25_4
16053 EDTTextBlock25_4 _textblock25_4;
16058 bool UseVersion25_4()
const;
16061 const FLAG_16* _GetFlagPtr()
const
16063 FIN25_4_CODE(
if (UseVersion25_4())
return &_textblock25_4.flag; )
16064 return &_textblock2004.flag;
16068 const eText* _GetTextIDPtr()
const
16070 FIN25_4_CODE(
if (UseVersion25_4())
return &_textblock25_4.textID; )
16071 return &_textblock2004.textID;
16075 const eShape* _GetShapeIDPtr()
const
16077 FIN25_4_CODE(
if (UseVersion25_4())
return &_textblock25_4.shapeID; )
16078 return &_textblock2004.shapeID;
16082 const twobyte* _GetLineSpacingPtr()
const
16084 FIN25_4_CODE(
if (UseVersion25_4())
return &_textblock25_4.lineSpacing; )
16085 return &_textblock2004.lineSpacing;
16089 const ETAG* _GetTextTagPtr()
const
16091 FIN25_4_CODE(
if (UseVersion25_4())
return &_textblock25_4.textTag; )
16092 return &_textblock2004.textTag;
16096 const Evpu16* _GetWidthPtr()
const
16098 FIN25_4_CODE(
if (UseVersion25_4())
return &_textblock25_4.width; )
16099 return &_textblock2004.width;
16103 const Evpu16* _GetHeightPtr()
const
16105 FIN25_4_CODE(
if (UseVersion25_4())
return &_textblock25_4.height; )
16106 return &_textblock2004.height;
16110 const Evpu16* _GetXaddPtr()
const
16112 FIN25_4_CODE(
if (UseVersion25_4())
return &_textblock25_4.xadd; )
16113 return &_textblock2004.xadd;
16117 const Evpu16* _GetYaddPtr()
const
16119 FIN25_4_CODE(
if (UseVersion25_4())
return &_textblock25_4.yadd; )
16120 return &_textblock2004.yadd;
16124 const EVPUFixedShort* _GetInsetHiPtr()
const
16126 FIN25_4_CODE(
if (UseVersion25_4())
return &_textblock25_4.insethi; )
16127 return &_textblock2004.insethi;
16131 const EVPUFixedShort* _GetInsetLoPtr()
const
16133 FIN25_4_CODE(
if (UseVersion25_4())
return &_textblock25_4.insetlo; )
16134 return &_textblock2004.insetlo;
16138 const EVPUFixedShort* _GetStdLineLoPtr()
const
16140 FIN25_4_CODE(
if (UseVersion25_4())
return &_textblock25_4.stdlinelo; )
16141 return &_textblock2004.stdlinelo;
16145 const EVPUFixedShort* _GetStdLineHiPtr()
const
16147 FIN25_4_CODE(
if (UseVersion25_4())
return &_textblock25_4.stdlinehi; )
16148 return &_textblock2004.stdlinehi;
16151#ifndef DOXYGEN_SHOULD_IGNORE_THIS
16153 EXTAG
Tag()
const override {
return ot_TextBlock; }
16156 FIN25_4_CODE(
if (UseVersion25_4())
return sizeof(EDTTextBlock25_4);)
16157 return sizeof(EDTTextBlock2004);
16161 FIN25_4_CODE(
if (UseVersion25_4())
return (
void*) &_textblock25_4; )
16162 return (
void*) &_textblock2004;
16185 TEXTJUSTIFY_LEFT = TEXT_JUSTIFY_LEFT,
16186 TEXTJUSTIFY_RIGHT = TEXT_JUSTIFY_RIGHT,
16187 TEXTJUSTIFY_CENTER = TEXT_JUSTIFY_CENTER,
16188 TEXTJUSTIFY_FULL = TEXT_JUSTIFY_FULL,
16189 TEXTJUSTIFY_FORCED_FULL = TEXT_JUSTIFY_FORCED_FULL
16193 const char*
ClassName()
const override {
return "FCTextBlock"; }
16196#ifndef DOXYGEN_SHOULD_IGNORE_THIS
16203 void* _GetTextBlock() {
return Allocate(); }
16211 memset(pTextBlock, 0, size);
16213 TEXTBLOCK_NEWPOS | TEXTBLOCK_SHOWMAINSHAPE |
16214 TEXTBLOCK_WORDWRAP | TEXTBLOCK_LINESPACINGISPERCENT,
16231 void _SetRawTextID(twobyte therawtextid) { *(eText*)_GetTextIDPtr() = therawtextid; }
16236 EXTAG rawtextextag = tx_TextBlock;
16237 rawtextextag &= 0xffff0000;
16238 rawtextextag |= *_GetTextTagPtr();
16239 return rawtextextag;
16259#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
16261 luabridge::RefCountedPtr<FCString> CreateRawTextString_GC()
16290 void SetShapeID(twobyte shapeID) { *(eShape*)_GetShapeIDPtr() = shapeID; }
16296 *(eText*)_GetTextIDPtr() = theid;
16297 *(ETAG*)_GetTextTagPtr() = tag;
16308 FLAG_16* pFlag = (FLAG_16*) _GetFlagPtr();
16309 *pFlag &= ~TEXTBLOCK_JUSTIBITS;
16310 *pFlag |= (justification % TEXTBLOCK_JUSTIBITS);
16334 void SetLineSpacing(twobyte linespacing) { *(twobyte*)_GetLineSpacingPtr() = linespacing; }
16345 return (*_GetFlagPtr() & TEXTBLOCK_JUSTIBITS);
16357 return GetBitFlag(*_GetFlagPtr(), TEXTBLOCK_NEWPOS);
16368 return GetBitFlag(*_GetFlagPtr(), TEXTBLOCK_LINESPACINGISPERCENT);
16379 return GetBitFlag(*_GetFlagPtr(), TEXTBLOCK_WORDWRAP);
16389 return !
GetBitFlag(*_GetFlagPtr(), TEXTBLOCK_NOEXPANDSINGLEWORD);
16402 FIN25_4_CODE(
if (UseVersion25_4())
return GetBitFlag(*_GetFlagPtr(), TEXTBLOCK_ROUND_CORNERS); )
16417 FIN25_4_CODE(
if (UseVersion25_4())
return _textblock25_4.m_cornerRadius; )
16434 Set16BitFlag((FLAG_16*) _GetFlagPtr(), TEXTBLOCK_NEWPOS, state);
16445 Set16BitFlag((FLAG_16*) _GetFlagPtr(), TEXTBLOCK_LINESPACINGISPERCENT, state);
16456 Set16BitFlag((FLAG_16*) _GetFlagPtr(), TEXTBLOCK_WORDWRAP, state);
16466 Set16BitFlag((FLAG_16*) _GetFlagPtr(), TEXTBLOCK_NOEXPANDSINGLEWORD, !state);
16479 FIN25_4_CODE(
if (UseVersion25_4())
Set16BitFlag((FLAG_16*) _GetFlagPtr(), TEXTBLOCK_ROUND_CORNERS, state); )
16493 FIN25_4_CODE(
if (UseVersion25_4()) _textblock25_4.m_cornerRadius = radius; )
16502 *(EVPUFixedShort*)_GetStdLineLoPtr() = LOWORD(value);
16503 *(EVPUFixedShort*)_GetStdLineHiPtr() = HIWORD(value);
16512 *(EVPUFixedShort*)_GetInsetLoPtr() = LOWORD(value);
16513 *(EVPUFixedShort*)_GetInsetHiPtr() = HIWORD(value);
16522 *(Evpu16*) _GetXaddPtr() = value;
16531 *(Evpu16*) _GetYaddPtr() = value;
16540 Set16BitFlag((FLAG_16*)_GetFlagPtr(), TEXTBLOCK_SHOWMAINSHAPE, state);
16553 *(Evpu16*)_GetWidthPtr() = width;
16566 *(Evpu16*)_GetHeightPtr() = height;
16576 return MAKELONG(*_GetStdLineLoPtr(), *_GetStdLineHiPtr());
16585 return MAKELONG(*_GetInsetLoPtr(), *_GetInsetHiPtr());
16594 return *_GetXaddPtr();
16603 return *_GetYaddPtr();
16612 return GetBitFlag(*_GetFlagPtr(), TEXTBLOCK_SHOWMAINSHAPE);
16625 return *_GetWidthPtr();
16638 return *_GetHeightPtr();
16664#ifdef PDK_FRAMEWORK_DEBUG
16669 DebugOutHex(
"Text tag (hex): ", *_GetTextTagPtr());
16689#ifndef DOXYGEN_SHOULD_IGNORE_THIS
16690 EDTPageText _pagetext;
16693#ifndef DOXYGEN_SHOULD_IGNORE_THIS
16695 EXTAG
Tag()
const override {
return ot_PageText; }
16696 int DataSizeLoad()
const override {
return sizeof(EDTPageText); }
16697 void*
Allocate()
override {
return (
void*) &_pagetext; }
16705 memcpy(&_pagetext, ((
FCPageText*)pSource)->_GetPageText(),
sizeof(_pagetext));
16718 if (
Load(0, 0))
return true;
16770#ifndef DOXYGEN_SHOULD_IGNORE_THIS
16777 void* _GetPageText() {
return Allocate(); }
16786 memset(&_pagetext, 0,
sizeof(_pagetext));
16806#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
16808 luabridge::RefCountedPtr<FCString> CreateTextString_GC()
16822#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
16824 luabridge::RefCountedPtr<FCTextBlock> CreateTextBlock_GC()
16836 return _pagetext.startPage;
16847 return _pagetext.endPage;
16856#ifndef PDK_FRAMEWORK_LUAFRIENDLY
16871#ifndef PDK_FRAMEWORK_LUAFRIENDLY
16887#ifndef PDK_FRAMEWORK_LUAFRIENDLY
16901#ifndef PDK_FRAMEWORK_LUAFRIENDLY
16920 return GetBitFlag(_pagetext.flag, PAGETEXT_HPOS_PAGE_EDGE);
16943 return _pagetext.xdisp;
16952 return _pagetext.rightpgxdisp;
16961 return _pagetext.ydisp;
16970 return _pagetext.rightpgydisp;
16980 return !
GetBitFlag(_pagetext.flag, (PAGETEXT_ANNOTATION));
16989 return GetBitFlag(_pagetext.flag, PAGETEXT_INDRP_POS);
16999 return _pagetext.block;
17008 _pagetext.block = textblockid;
17045#ifndef PDK_FRAMEWORK_LUAFRIENDLY
17053 _pagetext.flag &= ~PAGETEXT_HPOS_LP_BITS;
17054 _pagetext.flag |= ((alignment << 2) & PAGETEXT_HPOS_LP_BITS);
17065#ifndef PDK_FRAMEWORK_LUAFRIENDLY
17072 _pagetext.flag &= ~PAGETEXT_HPOS_RP_BITS;
17073 _pagetext.flag |= ((alignment << 4) & PAGETEXT_HPOS_RP_BITS);
17082#ifndef PDK_FRAMEWORK_LUAFRIENDLY
17090 _pagetext.flag &= ~PAGETEXT_VPOS_BITS;
17091 _pagetext.flag |= ((alignment << 8) & PAGETEXT_VPOS_BITS);
17099#ifndef PDK_FRAMEWORK_LUAFRIENDLY
17107 _pagetext.flag &= ~PAGETEXT_OE_BITS;
17108 _pagetext.flag |= (assign & PAGETEXT_OE_BITS);
17120 _pagetext.startPage = page;
17132 _pagetext.endPage = page;
17144 _pagetext.xdisp = value;
17154 _pagetext.rightpgxdisp = value;
17167 _pagetext.ydisp = value;
17177 _pagetext.rightpgydisp = value;
17187 Set16BitFlag(&_pagetext.flag, PAGETEXT_ANNOTATION, !visible);
17196 Set16BitFlag(&_pagetext.flag, PAGETEXT_INDRP_POS, state);
17212 Set16BitFlag(&_pagetext.flag, PAGETEXT_HPOS_PAGE_EDGE, state);
17213 Set16BitFlag(&_pagetext.flag, PAGETEXT_VPOS_PAGE_EDGE, state);
17239#ifdef PDK_FRAMEWORK_DEBUG
17272#ifndef DOXYGEN_SHOULD_IGNORE_THIS
17273 EDTSeparatePlacement _separateplacement;
17276#ifndef DOXYGEN_SHOULD_IGNORE_THIS
17279 int DataSizeLoad()
const override {
return sizeof(EDTSeparatePlacement); }
17280 void*
Allocate()
override {
return (
void*) &_separateplacement; }
17288 memcpy(&_separateplacement, ((
FCSeparatePlacement*)pSource)->_GetSeparatePlacement(),
sizeof(_separateplacement));
17316 const char*
ClassName()
const override {
return "FCSeparatePlacement"; }
17319#ifndef DOXYGEN_SHOULD_IGNORE_THIS
17326 void* _GetSeparatePlacement() {
return Allocate(); }
17335 memset(&_separateplacement, 0,
sizeof(_separateplacement));
17351#ifndef PDK_FRAMEWORK_LUAFRIENDLY
17387#ifndef PDK_FRAMEWORK_LUAFRIENDLY
17396 case ot_SeparateTextRepeatPlacement:
17398 case ot_SeparateEndingRepeatPlacement:
17400 case ot_SeparateEndingRepeatTextPlacement:
17402 case ot_SeparateBackwardRepeatPlacement:
17412 eStaff
GetStaff()
const override {
return _separateplacement.instno; }
17428 return _separateplacement.measure;
17468 return _separateplacement.x2add;
17490 return _separateplacement.y2add;
17504 void SetStaff(eStaff staff) { _separateplacement.instno = staff; }
17517 _separateplacement.measure = meas;
17556 _separateplacement.x2add = value;
17578 _separateplacement.y2add = value;
17598 return !
GetBitFlag(_separateplacement.measure, SEPARATES_HIDDEN);
17601 return !
GetBitFlag(_separateplacement.y2add, SEPARATES_HIDDEN);
17621 return Set16BitFlag(
reinterpret_cast<FLAG_16*
>(&_separateplacement.measure), SEPARATES_HIDDEN, !state);
17624 return Set16BitFlag(
reinterpret_cast<FLAG_16*
>(&_separateplacement.y2add), SEPARATES_HIDDEN, !state);
17643#ifndef DOXYGEN_SHOULD_IGNORE_THIS
17644 EDTScoreExpression2009 _expression;
17647#ifndef DOXYGEN_SHOULD_IGNORE_THIS
17649 int DataSizeLoad()
const override {
return sizeof(EDTScoreExpression2009); }
17650 void*
Allocate()
override {
return (
void*) &_expression; }
17658 memcpy(&_expression, ((
FCExpression*)pSource)->_GetExpression(),
sizeof(_expression));
17685 const char*
ClassName()
const override {
return "FCExpression"; }
17688 EXTAG
Tag()
const override {
return ot_ScoreExpression2009; }
17690#ifndef DOXYGEN_SHOULD_IGNORE_THIS
17697 void* _GetExpression() {
return Allocate(); }
17706 memset(&_expression, 0,
sizeof(_expression));
17758 twobyte
GetStaff()
const override {
return _expression.staffAssign; }
17760#ifdef PDK_FRAMEWORK_LAYOUT
17833 return (_expression.flag & 0x70) >> 4;
17842#ifndef PDK_FRAMEWORK_LUAFRIENDLY
17860 return !
GetBitFlag(_expression.flag, 0x1000);
17870 return !
GetBitFlag(_expression.flag, 0x0800);
17916 TimeEdu32
GetMeasurePos()
const override {
return 0x10000 * _expression.horzEDUOffHi + _expression.horzEDUOffLo; }
17959#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
17961 luabridge::RefCountedPtr<FCShapeExpressionDef> CreateShapeExpressionDef_GC()
17975#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
17977 luabridge::RefCountedPtr<FCTextExpressionDef> CreateTextExpressionDef_GC()
18015 twobyte
GetID()
const {
return _expression.dynumber; }
18032 void SetID(twobyte
id) { _expression.dynumber = id; }
18043 _expression.flag &= ~0x07;
18044 _expression.flag |= layer;
18079 _expression.flag &= ~0x70;
18080 _expression.flag |= layer;
18090#ifndef PDK_FRAMEWORK_LUAFRIENDLY
18121 void SetStaff(twobyte staffno) { _expression.staffAssign = staffno; }
18175 _expression.horzEDUOffHi = (value & 0xffff0000) / 0x10000;
18176 _expression.horzEDUOffLo = value & 0x0000ffff;
18200 if (index < 0)
return;
18201 _expression.graceNoteIndex = index;
18204#ifdef PDK_FRAMEWORK_DEBUG
18209 DebugOutHex(
"Flag bits (hex): ", _expression.flag);
18223#define __STAFFSTYLEDEF_RETURN_FIELD_PTR(field) \
18224switch (_VersionToUse()) \
18226 case FINALEVERSION_2014: \
18227 return &_staffstyledef2014.field; \
18228 case FINALEVERSION_2012: \
18229 return &_staffstyledef2012.field; \
18231 return &_staffstyledef2010.field; \
18246 const bool _skipWorkaround;
18248#ifndef DOXYGEN_SHOULD_IGNORE_THIS
18249 EDTStaffStyle2010 _staffstyledef2010;
18251#if FXT_VERSION >= FINALEVERSION_2012
18252 EDTStaffStyle2012 _staffstyledef2012;
18254 EDTStaffStyle2010 _staffstyledef2012;
18257#if FXT_VERSION >= FINALEVERSION_2014
18258 EDTStaffStyle2014 _staffstyledef2014;
18260 EDTStaffStyle2010 _staffstyledef2014;
18264 const uonebyte* _GetInstUUIDPtr()
const override
18266 if (_VersionToUse() >= FINALEVERSION_2014)
18267 return _staffstyledef2014.instUUID;
18268 if (_VersionToUse() >= FINALEVERSION_2012)
18269 return _staffstyledef2012.instUUID;
18274 const FLAG_16* _GetInstFlagPtr()
const override
18276 __STAFFSTYLEDEF_RETURN_FIELD_PTR(instflag);
18280 const FLAG_16* _GetFlagPtr()
const override
18282 __STAFFSTYLEDEF_RETURN_FIELD_PTR(flag);
18286 const FLAG_16* _GetAltFlagPtr()
const override
18288 __STAFFSTYLEDEF_RETURN_FIELD_PTR(altFlag);
18292 const FLAG_16* _GetAltFlag2Ptr()
const override
18294 __STAFFSTYLEDEF_RETURN_FIELD_PTR(altFlag2);
18298 const twobyte* _GetTranspositionPtr()
const override
18300 __STAFFSTYLEDEF_RETURN_FIELD_PTR(transposition);
18304 const FLAG_16* _GetMoreFlagsPtr()
const override
18306 __STAFFSTYLEDEF_RETURN_FIELD_PTR(moreFlags);
18310 const FLAG_16* _GetMoreFlags2Ptr()
const override
18312 if (_VersionToUse() < FINALEVERSION_2014)
return NULL;
18313#if FXT_VERSION < FINALEVERSION_25
18314 return (
const FLAG_16*) &_staffstyledef2014.hideKeySigsShowAccis;
18316 return &_staffstyledef2014.moreFlags2;
18321 const FLAG_16* _GetMoreFlags3Ptr()
const override
18323 if (_VersionToUse() < FINALEVERSION_2014)
return NULL;
18324#if FXT_VERSION < FINALEVERSION_25
18325 return (
const FLAG_16*) &_staffstyledef2014.redisplayLayerAccis;
18327 return &_staffstyledef2014.moreFlags3;
18332 const FLAG_16* _GetMask1FlagPtr()
const
18334 __STAFFSTYLEDEF_RETURN_FIELD_PTR(mask1);
18338 const FLAG_16* _GetMask2FlagPtr()
const
18340 __STAFFSTYLEDEF_RETURN_FIELD_PTR(mask2);
18344 const FLAG_16* _GetMask3FlagPtr()
const
18346 __STAFFSTYLEDEF_RETURN_FIELD_PTR(mask3);
18350 const FLAG_16* _GetSFFlagPtr()
const
18352 __STAFFSTYLEDEF_RETURN_FIELD_PTR(sfflag);
18356 const twobyte* _GetAbbrvNamePtr()
const override
18358 __STAFFSTYLEDEF_RETURN_FIELD_PTR(abbrvName);
18362 const twobyte* _GetFullNamePtr()
const override
18364 __STAFFSTYLEDEF_RETURN_FIELD_PTR(fullName);
18368 const twobyte* _GetClefsPtr()
const override
18370 __STAFFSTYLEDEF_RETURN_FIELD_PTR(clefs);
18374 const Efix32* _GetVertTabNumOffPtr()
const override
18376 __STAFFSTYLEDEF_RETURN_FIELD_PTR(vertTabNumOff);
18380 const CMPER* _GetFretInstIDPtr()
const override
18382 __STAFFSTYLEDEF_RETURN_FIELD_PTR(fretInstID);
18386 const Evpu16* _GetBottomBarlineOffsetPtr()
const override
18388 __STAFFSTYLEDEF_RETURN_FIELD_PTR(botBarlineOffset);
18392 const Evpu16* _GetTopBarlineOffsetPtr()
const override
18394 __STAFFSTYLEDEF_RETURN_FIELD_PTR(topBarlineOffset);
18398 const utwobyte* _GetCapoLowFretPtr()
const override
18400 __STAFFSTYLEDEF_RETURN_FIELD_PTR(capoLowFret);
18404 const FLAG_16* _GetBotLinesPtr()
const override
18406 __STAFFSTYLEDEF_RETURN_FIELD_PTR(botLines);
18410 const FLAG_16* _GetTopLinesPtr()
const override
18412 __STAFFSTYLEDEF_RETURN_FIELD_PTR(topLines);
18416 const Efix32* _GetLineSpacePtr()
const override
18418 __STAFFSTYLEDEF_RETURN_FIELD_PTR(lineSpace);
18422 const twobyte* _GetDwWRestPtr()
const override
18424 __STAFFSTYLEDEF_RETURN_FIELD_PTR(dw_wRest);
18428 const twobyte* _GetStemReversalPtr()
const override
18430 __STAFFSTYLEDEF_RETURN_FIELD_PTR(stemReversal);
18434 const twobyte* _GetRepeatDotsOffPtr()
const override
18436 __STAFFSTYLEDEF_RETURN_FIELD_PTR(repeatDotsOff);
18440 const twobyte* _GetHOtherRestPtr()
const override
18442 __STAFFSTYLEDEF_RETURN_FIELD_PTR(h_otherRest);
18446 const EFONTID* _GetMFontPtr()
const override
18448 __STAFFSTYLEDEF_RETURN_FIELD_PTR(mfont);
18452 const twobyte* _GetSizeEfxPtr()
const override
18454 __STAFFSTYLEDEF_RETURN_FIELD_PTR(sizeefx);
18458 const Efix32* _GetHorzStemOffUpPtr()
const override
18460 __STAFFSTYLEDEF_RETURN_FIELD_PTR(horzStemOffUp);
18464 const Efix32* _GetHorzStemOffDownPtr()
const override
18466 __STAFFSTYLEDEF_RETURN_FIELD_PTR(horzStemOffDown);
18470 const Efix32* _GetVertStemStartOffUpPtr()
const override
18472 __STAFFSTYLEDEF_RETURN_FIELD_PTR(vertStemStartOffUp);
18476 const Efix32* _GetVertStemStartOffDownPtr()
const override
18478 __STAFFSTYLEDEF_RETURN_FIELD_PTR(vertStemStartOffDown);
18482 const Efix32* _GetVertStemEndOffUpPtr()
const override
18484 __STAFFSTYLEDEF_RETURN_FIELD_PTR(vertStemEndOffUp);
18488 const Efix32* _GetVertStemEndOffDownPtr()
const override
18490 __STAFFSTYLEDEF_RETURN_FIELD_PTR(vertStemEndOffDown);
18494 FLAG_16 GetMask1()
const {
return *_GetMask1FlagPtr(); }
18497 FLAG_16 GetMask2()
const {
return *_GetMask2FlagPtr(); }
18500 FLAG_16 GetMask3()
const {
return *_GetMask3FlagPtr(); }
18506 EXTAG _GetFullNamePosTag()
const override {
return ot_NamePosFullStyle; }
18512 twobyte _GetFullNamePosCmper()
const override {
return GetItemNo(); }
18518 EXTAG _GetAbbreviatedNamePosTag()
const override {
return ot_NamePosAbbrvStyle; }
18524 twobyte _GetAbbreviatedNamePosCmper()
const override {
return GetItemNo(); }
18526#ifdef PDK_FRAMEWORK_PREFS
18528 virtual bool _SaveNewFullNamePos()
override
18529 {
return this->_pFullNamePosition && this->_pFullNamePosition->SaveAs(
GetItemNo()); }
18532 virtual bool _SaveNewAbbreviatedNamePos()
override
18533 {
return this->_pAbbreviatedNamePosition && this->_pAbbreviatedNamePosition->SaveAs(
GetItemNo()); }
18543 for (
int i = 1; i <= 2000; i++)
18545 if (
Load(i))
return true;
18558 for (
int i = 1; i <= 2000; i++)
18560 if (
Load(itemno + i))
return true;
18566 bool _SaveRawFields()
const;
18577#ifndef DOXYGEN_SHOULD_IGNORE_THIS
18579 EXTAG
Tag()
const override {
return ot_EDTStaffStyle2010; }
18582 switch (_VersionToUse())
18584 case FINALEVERSION_2014:
18585 return sizeof(EDTStaffStyle2014);
18586 case FINALEVERSION_2012:
18587 return sizeof(EDTStaffStyle2012);
18589 return sizeof(EDTStaffStyle2010);
18594 switch (_VersionToUse())
18596 case FINALEVERSION_2014:
18597 return (
void*) &_staffstyledef2014;
18598 case FINALEVERSION_2012:
18599 return (
void*) &_staffstyledef2012;
18601 return (
void*) &_staffstyledef2010;
18604 EVERSION
EnigmaVersion()
const override {
return _VersionToUse(); }
18621 const char*
ClassName()
const override {
return "FCStaffStyleDef"; }
18624#ifndef DOXYGEN_SHOULD_IGNORE_THIS
18631 void* _GetStaffStyle() {
return Allocate(); }
18634 bool Load(CMPER itemno)
override;
18637 bool Save()
override
18640 return _SaveRawFields();
18647 return _SaveRawFields();
18658#ifdef PDK_FRAMEWORK_LUAFRIENDLY
18669 return _OneOptionalParamLuaConstructor<FCStaffStyleDef, bool>(ptr, L);
19022 Set16BitFlag((FLAG_16*) _GetMask2FlagPtr(), SFMASK2_NEGKEY, state);
19032 Set16BitFlag((FLAG_16*)_GetMask1FlagPtr(), SFMASK1_NEGMNUMB, state);
19044 Set16BitFlag((FLAG_16*)_GetMask2FlagPtr(), SFMASK2_NEGTIME, state);
19053 Set16BitFlag((FLAG_16*)_GetMask3FlagPtr(), SFMASK3_NEGTIME_PARTS, state);
19063 Set16BitFlag((FLAG_16*)_GetMask2FlagPtr(), SFMASK2_NEGCLEF, state);
19073 Set16BitFlag((FLAG_16*)_GetMask3FlagPtr(), SFMASK3_HIDE_CHORDS, state);
19083 Set16BitFlag((FLAG_16*)_GetMask2FlagPtr(), SFMASK2_SHOWDOTS, state);
19093 Set16BitFlag((FLAG_16*)_GetMask3FlagPtr(), SFMASK3_HIDE_FRETBOARDS, state);
19103 Set16BitFlag((FLAG_16*)_GetMask3FlagPtr(), SFMASK3_HIDE_LYRICS, state);
19113 Set16BitFlag((FLAG_16*)_GetMask2FlagPtr(), SFMASK2_HIDE_RPT_BARS, state);
19123 Set16BitFlag((FLAG_16*)_GetMask2FlagPtr(), SFMASK2_SHOWRESTS, state);
19142 Set16BitFlag((FLAG_16*)_GetMask1FlagPtr(), SFMASK1_NEGNAME, state);
19152 Set16BitFlag((FLAG_16*)_GetMask3FlagPtr(), SFMASK3_SHOWNAME_PARTS, state);
19163 Set16BitFlag((FLAG_16*)_GetMask3FlagPtr(), SFMASK3_SHOWSTEMS, state);
19173 Set16BitFlag((FLAG_16*)_GetMask2FlagPtr(), SFMASK2_SHOWTIES, state);
19372#ifdef PDK_FRAMEWORK_PREFS
19417#ifdef PDK_FRAMEWORK_DEBUG
19439#ifndef DOXYGEN_SHOULD_IGNORE_THIS
19440 EDTStaffStyleAssign _staffstyleassign;
19443#ifndef DOXYGEN_SHOULD_IGNORE_THIS
19445 EXTAG
Tag()
const override {
return ot_EDTStaffStyleAssign; }
19446 int DataSizeLoad()
const override {
return sizeof(EDTStaffStyleAssign); }
19447 void*
Allocate()
override {
return (
void*) &_staffstyleassign; }
19455 memcpy(&_staffstyleassign, ((
FCStaffStyleAssign*)pSource)->_GetStaffStyleAssign(),
sizeof(_staffstyleassign));
19465 const char*
ClassName()
const override {
return "FCStaffStyleAssign"; }
19468#ifndef DOXYGEN_SHOULD_IGNORE_THIS
19475 void* _GetStaffStyleAssign() {
return Allocate(); }
19484 memset(&_staffstyleassign, 0,
sizeof(_staffstyleassign));
19487 _staffstyleassign.range.end.edu = 0x7fffffff;
19572 if (!pRegion)
return false;
19588#ifdef PDK_FRAMEWORK_DEBUG
19615#ifndef DOXYGEN_SHOULD_IGNORE_THIS
19616 EDTMultimeasureRest _mmrest;
19620#ifndef DOXYGEN_SHOULD_IGNORE_THIS
19622 EXTAG
Tag()
const override {
return ot_MultimeasureRest; }
19623 int DataSizeLoad()
const override {
return sizeof(EDTMultimeasureRest); }
19624 void*
Allocate()
override {
return (
void*) &_mmrest; }
19647 bool SaveNew()
override {
return false; }
19650 const char*
ClassName()
const override {
return "FCMultiMeasureRest"; }
19653#ifndef DOXYGEN_SHOULD_IGNORE_THIS
19660 void* _GetMMRest() {
return Allocate(); }
19670 memset(&_mmrest, 0,
sizeof(_mmrest));
19712 return GetBitFlag(_mmrest.flag, MMREST_USE_SYMBOLS);
19723 return _mmrest.symbolMeasures;
19786 void SetWidth(twobyte value) { _mmrest.measureWidth = value; }
19834 Set16BitFlag(&_mmrest.flag, MMREST_USE_SYMBOLS, value);
19845 _mmrest.symbolMeasures = value;
19903#ifdef PDK_FRAMEWORK_PREFS
19914#ifdef PDK_FRAMEWORK_DEBUG
19924#if FXT_VERSION >= FINALEVERSION_2012
19935#ifndef DOXYGEN_SHOULD_IGNORE_THIS
19936 EDTMultiStaffInstGroup _multistaffinstgroup;
19940#ifndef DOXYGEN_SHOULD_IGNORE_THIS
19942 EXTAG
Tag()
const override {
return otx_MultiStaffInstGroup; }
19943 int DataSizeLoad()
const override {
return sizeof(EDTMultiStaffInstGroup); }
19944 void*
Allocate()
override {
return (
void*) &_multistaffinstgroup; }
19954 memcpy(&_multistaffinstgroup, ((
FCMultiStaffInstrument*)pSource)->_GetMultiStaffInstGroup(),
sizeof(_multistaffinstgroup));
19968 const char*
ClassName()
const override {
return "FCMultiStaffInstrument"; }
19971#ifndef DOXYGEN_SHOULD_IGNORE_THIS
19978 void* _GetMultiStaffInstGroup() {
return Allocate(); }
19988 memset(&_multistaffinstgroup, 0,
sizeof(_multistaffinstgroup));
19998 if (staffno == 0)
return false;
20029 return _multistaffinstgroup.staffGroupID;
20059 _multistaffinstgroup.staffGroupID = value;
20071 CMPER returnvalue = 0;
20072 twobyte lowestslot = 10000;
20076 lowestslot = slottest;
20080 if ((slottest) && (slottest < lowestslot))
20082 lowestslot = slottest;
20086 if ((slottest) && (slottest < lowestslot))
20090 return returnvalue;
20101 CMPER returnvalue = 0;
20102 twobyte highestslot = -10000;
20106 highestslot = slottest;
20110 if ((slottest) && (slottest > highestslot))
20112 highestslot = slottest;
20116 if ((slottest) && (slottest > highestslot))
20120 return returnvalue;
20124#ifdef PDK_FRAMEWORK_DEBUG
20149#ifndef DOXYGEN_SHOULD_IGNORE_THIS
20150 EDTAllotment _allotment;
20154#ifndef DOXYGEN_SHOULD_IGNORE_THIS
20156 EXTAG
Tag()
const override {
return ot_Allotment; }
20157 int DataSizeLoad()
const override {
return sizeof(EDTAllotment); }
20158 void*
Allocate()
override {
return (
void*) &_allotment; }
20168 memcpy(&_allotment, ((
FCAllotment*)pSource)->_GetAllotment(),
sizeof(_allotment));
20183 EDTAllotment scratch;
20190 const char*
ClassName()
const override {
return "FCAllotment"; }
20193#ifndef DOXYGEN_SHOULD_IGNORE_THIS
20200 void* _GetAllotment() {
return Allocate(); }
20209 memset(&_allotment, 0,
sizeof(_allotment));
20220 _allotment.allotment = width;
20230 return _allotment.allotment;
20234#ifdef PDK_FRAMEWORK_DEBUG
20253#ifndef DOXYGEN_SHOULD_IGNORE_THIS
20256 EDTTGraphic _graphic;
20258 EXTAG
Tag()
const override {
return ot_PageGraphic; }
20259 int DataSizeLoad()
const override {
return sizeof(EDTTGraphic); }
20260 void*
Allocate()
override {
return (
void*) &_graphic; }
20262 EVERSION
EnigmaVersion()
const override {
return FINALEVERSION_2010; }
20270 memcpy(&_graphic, ((
FCPageGraphic*)pSource)->_GetGraphic(),
sizeof(_graphic));
20279 if (
Load(0, 0))
return true;
20288 bool _RawRelink()
override;
20295 const char*
ClassName()
const override {
return "FCPageGraphic"; }
20298#ifndef DOXYGEN_SHOULD_IGNORE_THIS
20305 void* _GetGraphic() {
return &_graphic; }
20345 memset(&_graphic, 0,
sizeof(_graphic));
20354 return MAKEBOOL(_graphic.graphicCmper);
20363 return _graphic.start;
20372 return _graphic.end;
20381 return _graphic.left;
20390 return _graphic.bottom;
20399 return _graphic.width;
20408 return _graphic.height;
20417 return _graphic.origWidth;
20426 return _graphic.origHeight;
20477#ifndef PDK_FRAMEWORK_LUAFRIENDLY
20495#ifndef PDK_FRAMEWORK_LUAFRIENDLY
20513#ifndef PDK_FRAMEWORK_LUAFRIENDLY
20533 _graphic.start = pageno;
20542 _graphic.end = pageno;
20554 _graphic.left = pos;
20567 _graphic.bottom = pos;
20577 _graphic.width = width;
20586 _graphic.height = height;
20595 Set16BitFlag(&_graphic.displayFlags, GRAPHIC_DISPLAY_HIDDEN, !state);
20611 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_MARGINS, !state);
20612 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_PAPER, state);
20624 _graphic.rightPgAlignFlags = _graphic.alignFlags;
20626 _graphic.rightPgAlignFlags = 0;
20635 _graphic.rightPgLeft = value;
20644 _graphic.rightPgBottom = value;
20664#ifndef PDK_FRAMEWORK_LUAFRIENDLY
20675 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_LEFT,
true);
20676 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_RIGHT,
false);
20677 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_CENTERH,
false);
20680 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_LEFT,
false);
20681 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_RIGHT,
true);
20682 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_CENTERH,
false);
20685 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_LEFT,
false);
20686 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_RIGHT,
false);
20687 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_CENTERH,
true);
20700#ifndef PDK_FRAMEWORK_LUAFRIENDLY
20710 Set16BitFlag(&_graphic.rightPgAlignFlags, GRAPHIC_ALIGN_LEFT,
true);
20711 Set16BitFlag(&_graphic.rightPgAlignFlags, GRAPHIC_ALIGN_RIGHT,
false);
20712 Set16BitFlag(&_graphic.rightPgAlignFlags, GRAPHIC_ALIGN_CENTERH,
false);
20715 Set16BitFlag(&_graphic.rightPgAlignFlags, GRAPHIC_ALIGN_LEFT,
false);
20716 Set16BitFlag(&_graphic.rightPgAlignFlags, GRAPHIC_ALIGN_RIGHT,
true);
20717 Set16BitFlag(&_graphic.rightPgAlignFlags, GRAPHIC_ALIGN_CENTERH,
false);
20720 Set16BitFlag(&_graphic.rightPgAlignFlags, GRAPHIC_ALIGN_LEFT,
false);
20721 Set16BitFlag(&_graphic.rightPgAlignFlags, GRAPHIC_ALIGN_RIGHT,
false);
20722 Set16BitFlag(&_graphic.rightPgAlignFlags, GRAPHIC_ALIGN_CENTERH,
true);
20734#ifndef PDK_FRAMEWORK_LUAFRIENDLY
20747 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_TOP,
true);
20748 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_BOTTOM,
false);
20749 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_CENTERV,
false);
20752 Set16BitFlag(&_graphic.rightPgAlignFlags, GRAPHIC_ALIGN_TOP,
true);
20753 Set16BitFlag(&_graphic.rightPgAlignFlags, GRAPHIC_ALIGN_BOTTOM,
false);
20754 Set16BitFlag(&_graphic.rightPgAlignFlags, GRAPHIC_ALIGN_CENTERV,
false);
20758 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_TOP,
false);
20759 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_BOTTOM,
true);
20760 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_CENTERV,
false);
20763 Set16BitFlag(&_graphic.rightPgAlignFlags, GRAPHIC_ALIGN_TOP,
false);
20764 Set16BitFlag(&_graphic.rightPgAlignFlags, GRAPHIC_ALIGN_BOTTOM,
true);
20765 Set16BitFlag(&_graphic.rightPgAlignFlags, GRAPHIC_ALIGN_CENTERV,
false);
20769 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_TOP,
false);
20770 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_BOTTOM,
false);
20771 Set16BitFlag(&_graphic.alignFlags, GRAPHIC_ALIGN_CENTERV,
true);
20774 Set16BitFlag(&_graphic.rightPgAlignFlags, GRAPHIC_ALIGN_TOP,
false);
20775 Set16BitFlag(&_graphic.rightPgAlignFlags, GRAPHIC_ALIGN_BOTTOM,
false);
20776 Set16BitFlag(&_graphic.rightPgAlignFlags, GRAPHIC_ALIGN_CENTERV,
true);
20799#ifndef DOXYGEN_SHOULD_IGNORE_THIS
20801 EDTTextRepeatStyle2005 _repeatdef;
20804 EXTAG
Tag()
const override {
return ot_TextRepeatStyle; }
20805 int DataSizeLoad()
const override {
return sizeof(EDTTextRepeatStyle2005); }
20806 void*
Allocate()
override {
return (
void*) &_repeatdef; }
20814 memcpy(&_repeatdef, ((
FCTextRepeatDef*)pSource)->_GetRepeatDef(),
sizeof(_repeatdef));
20823 if (!returnval)
return false;
20828 bool stringexists = !pString->
IsEmpty();
20830 return stringexists;
20840 bool _SaveTextAs(
FCString* pString, CMPER itemno);
20844 bool _DeleteText();
20848 bool _DeleteEnclosure();
20889 const char*
ClassName()
const override {
return "FCTextRepeatDef"; }
20892#ifndef DOXYGEN_SHOULD_IGNORE_THIS
20899 void* _GetRepeatDef() {
return &_repeatdef; }
20923 _DeleteEnclosure();
20938#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
20940 luabridge::RefCountedPtr<FCString> CreateTextString_GC()
20985#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
20987 luabridge::RefCountedPtr<FCEnclosure> CreateEnclosure_GC()
21011 if (!pInfo)
return;
21014 pInfo->
SetSize(_repeatdef.size);
21023 if (!pInfo)
return;
21026 _repeatdef.size = pInfo->
GetSize();
21036 return GetBitFlag(_repeatdef.flag, TEXT_REPEAT_USETHISFONT);
21046 return Set16BitFlag(&_repeatdef.flag, TEXT_REPEAT_USETHISFONT, state);
21055#ifndef PDK_FRAMEWORK_LUAFRIENDLY
21069#ifndef PDK_FRAMEWORK_LUAFRIENDLY
21081#ifndef PDK_FRAMEWORK_LUAFRIENDLY
21095#ifndef PDK_FRAMEWORK_LUAFRIENDLY
21104#ifdef PDK_FRAMEWORK_DEBUG
21130#ifndef DOXYGEN_SHOULD_IGNORE_THIS
21131 EDTTextRepeat2005 _textrepeat;
21134#ifndef DOXYGEN_SHOULD_IGNORE_THIS
21136 EXTAG
Tag()
const override {
return ot_TextRepeat2005; }
21137 int DataSizeLoad()
const override {
return sizeof(EDTTextRepeat2005); }
21138 void*
Allocate()
override {
return (
void*) &_textrepeat; }
21146 memcpy(&_textrepeat, ((
FCTextRepeat*)pSource)->_GetTextRepeat(),
sizeof(_textrepeat));
21155 const char*
ClassName()
const override {
return "FCTextRepeat"; }
21158#ifndef DOXYGEN_SHOULD_IGNORE_THIS
21165 void* _GetTextRepeat() {
return &_textrepeat; }
21255 memset(&_textrepeat, 0,
sizeof(_textrepeat));
21276#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
21278 luabridge::RefCountedPtr<FCTextRepeatDef> CreateTextRepeatDef_GC()
21296#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
21298 luabridge::RefCountedPtr<FCSeparatePlacements> CreateSeparatePlacements_GC()
21311 twobyte
GetID()
const {
return _textrepeat.repnum; }
21322 void SetID(twobyte
id) { _textrepeat.repnum = id; }
21385 return GetBitFlag(_textrepeat.flag, TXTRPT_INDIVPLAC);
21397 Set16BitFlag(&_textrepeat.flag, TXTRPT_INDIVPLAC, state);
21409 return !
GetBitFlag(_textrepeat.flag, 0x4000);
21428#ifndef PDK_FRAMEWORK_LUAFRIENDLY
21442#ifndef PDK_FRAMEWORK_LUAFRIENDLY
21463 if (list < 0)
return;
21464 _textrepeat.staffList = list;
21465 Set16BitFlag(&_textrepeat.flag, TXTRPT_TOPSTAFFONLY,
false);
21480 _textrepeat.actuate = totalpasses;
21517#ifndef PDK_FRAMEWORK_LUAFRIENDLY
21535#ifndef PDK_FRAMEWORK_LUAFRIENDLY
21551#ifndef PDK_FRAMEWORK_LUAFRIENDLY
21567#ifndef PDK_FRAMEWORK_LUAFRIENDLY
21575#ifdef PDK_FRAMEWORK_DEBUG
21579 DebugOutHex(
"FCTextRepeat:flag: ", _textrepeat.flag);
21592#ifndef DOXYGEN_SHOULD_IGNORE_THIS
21594 EDTExecutableShapeDef _executableshapedef;
21597 EXTAG
Tag()
const override {
return ot_ExecutableShapeDef; }
21598 int DataSizeLoad()
const override {
return sizeof(EDTExecutableShapeDef); }
21599 void*
Allocate()
override {
return (
void*) &_executableshapedef; }
21607 memcpy(&_executableshapedef, ((
FCExecutableShapeDef*)pSource)->_GetExecutableShapeDef(),
sizeof(_executableshapedef));
21629 const char*
ClassName()
const override {
return "FCExecutableShapeDef"; }
21632#ifndef DOXYGEN_SHOULD_IGNORE_THIS
21639 void* _GetExecutableShapeDef() {
return &_executableshapedef; }
21652 void SetShapeID(twobyte shapeID) { _executableshapedef.shapeID = shapeID; }
21654#ifdef PDK_FRAMEWORK_DEBUG
21678#ifndef DOXYGEN_SHOULD_IGNORE_THIS
21681 EDTChordSuffix _chordsuffixold;
21682#if FXT_VERSION >= FINALEVERSION_2012
21683 EDTChordSuffix2012 _chordsuffix2012;
21687 bool _Use2012Version()
const;
21689 EXTAG
Tag()
const override {
return ot_ChordSuffix; }
21692#if FXT_VERSION >= FINALEVERSION_2012
21693 if (_Use2012Version())
return sizeof(EDTChordSuffix2012);
21695 return sizeof(EDTChordSuffix);
21699#if FXT_VERSION >= FINALEVERSION_2012
21700 if (_Use2012Version())
return (
void*) &_chordsuffix2012;
21702 return (
void*) &_chordsuffixold;
21706 if (_Use2012Version())
return FINALEVERSION_2012;
21707 return FINALEVERSION_2010;
21719 const char*
ClassName()
const override {
return "FCChordSuffixElement"; }
21722#ifndef DOXYGEN_SHOULD_IGNORE_THIS
21729 void* _GetDataPtr()
21731#if FXT_VERSION >= FINALEVERSION_2012
21732 if (_Use2012Version())
return &_chordsuffix2012;
21734 return &_chordsuffixold;
21851#ifdef PDK_FRAMEWORK_DEBUG
21860#if FXT_VERSION >= FINALEVERSION_2012
21862#ifndef DOXYGEN_SHOULD_IGNORE_THIS
21867#if FXT_VERSION >= FINALEVERSION_25
21868const EXTAG __ot_FRETSTYLE = MAKEEXTAG(MAKETAG(edMultiInciOther,31),
'f',
't');
21869const int __MAX_FRET_NAME_LEN = 48 *
sizeof(eUniChar16);
21870const int __MAX_FRET_NUM_TEXT_LEN = 24 *
sizeof(eUniChar16);
21872const EXTAG __ot_FRETSTYLE = MAKEEXTAG(MAKETAG(edMultiInciOther,13),
'f',
't');
21873const int __MAX_FRET_NAME_LEN = 48;
21874const int __MAX_FRET_NUM_TEXT_LEN = 24;
21878#include "pragma_align_begin.h"
21879struct __FCFretStyle
21883 tbool showLastFret;
21885 tbool fingNumWhite;
21891 eShape fingStrShapeID;
21893 eShape openStrShapeID;
21895 eShape muteStrShapeID;
21898 eShape barreShapeID;
21900 eShape customShapeID;
21902 utwobyte defNumFrets;
21907 twobyte stringGapHi;
21908 twobyte stringGapLo;
21914 twobyte stringWidthHi;
21915 twobyte stringWidthLo;
21917 twobyte fretWidthHi;
21918 twobyte fretWidthLo;
21920 twobyte nutWidthHi;
21922 twobyte nutWidthLo;
21924 twobyte vertTextOffHi;
21925 twobyte vertTextOffLo;
21927 twobyte horzTextOffHi;
21928 twobyte horzTextOffLo;
21930 twobyte horzHandleOffHi;
21932 twobyte horzHandleOffLo;
21934 twobyte vertHandleOffHi;
21935 twobyte vertHandleOffLo;
21937 twobyte whiteoutHi;
21938 twobyte whiteoutLo;
21942 EFONTID fretNumFontID;
21944 FontPoints16 fretNumFontSize;
21945 FLAG_16 fretNumFontEfx;
21947 EFONTID fingNumFontID;
21948 FontPoints16 fingNumFontSize;
21949 FLAG_16 fingNumFontEfx;
21952 twobyte horzFingNumOffHi;
21954 twobyte horzFingNumOffLo;
21956 twobyte vertFingNumOffHi;
21957 twobyte vertFingNumOffLo;
21961#if FXT_VERSION >= FINALEVERSION_25
21963 eUniChar16 name[__MAX_FRET_NAME_LEN];
21966 eUniChar16 fretNumText[__MAX_FRET_NUM_TEXT_LEN];
21972 ECHAR name[__MAX_FRET_NAME_LEN];
21975 ECHAR fretNumText[__MAX_FRET_NUM_TEXT_LEN];
21981#include "pragma_align_end.h"
21997#ifndef DOXYGEN_SHOULD_IGNORE_THIS
21999 __FCFretStyle _fretstyledef;
22002 EXTAG
Tag()
const override {
return __ot_FRETSTYLE; }
22003 int DataSizeLoad()
const override {
return sizeof(__FCFretStyle); }
22004 void*
Allocate()
override {
return (
void*)&_fretstyledef; }
22005 EVERSION
EnigmaVersion()
const override {
return FINALEVERSION_2010; }
22013 memcpy(&_fretstyledef, ((
FCFretboardStyleDef*)pSource)->_GetFretStyleDef(),
sizeof(_fretstyledef));
22035 const char*
ClassName()
const override {
return "FCFretboardStyleDef"; }
22038#ifndef DOXYGEN_SHOULD_IGNORE_THIS
22045 void* _GetFretStyleDef() {
return &_fretstyledef; }
22055 memset(&_fretstyledef, 0,
sizeof(_fretstyledef));
22072 if (!pString)
return;
22073#if FXT_VERSION >= FINALEVERSION_25
22084 Efix32
GetStringSpacing()
const {
return MAKELONG(_fretstyledef.stringGapLo, _fretstyledef.stringGapHi); }
22090 Efix32
GetStringThickness()
const {
return MAKELONG(_fretstyledef.stringWidthLo, _fretstyledef.stringWidthHi); }
22096 Efix32
GetFretSpacing()
const {
return MAKELONG(_fretstyledef.fretGapLo, _fretstyledef.fretGapHi); }
22102 Efix32
GetFretThickness()
const {
return MAKELONG(_fretstyledef.fretWidthLo, _fretstyledef.fretWidthHi); }
22108 Efix32
GetNutThickness()
const {
return MAKELONG(_fretstyledef.nutWidthLo, _fretstyledef.nutWidthHi); }
22148 if (!pString)
return;
22149#if FXT_VERSION >= FINALEVERSION_25
22152 pString->
SetCString(_fretstyledef.fretNumText);
22200 return _fretstyledef.fingStrShapeID;
22209 return _fretstyledef.openStrShapeID;
22218 return _fretstyledef.muteStrShapeID;
22227 return _fretstyledef.barreShapeID;
22236 return _fretstyledef.customShapeID;
22247 if (!pFontInfo)
return;
22248 pFontInfo->
SetNameByID(_fretstyledef.fingNumFontID);
22249 pFontInfo->
SetSize(_fretstyledef.fingNumFontSize);
22261 if (!pFontInfo)
return;
22262 pFontInfo->
SetNameByID(_fretstyledef.fretNumFontID);
22263 pFontInfo->
SetSize(_fretstyledef.fretNumFontSize);
22279 if (!pString)
return;
22280 memset(&_fretstyledef.name, 0,
sizeof(_fretstyledef.name));
22281#if FXT_VERSION >= FINALEVERSION_25
22284 strncpy(_fretstyledef.name, pString->
GetCString(),
sizeof(_fretstyledef.name) - 1);
22294 _fretstyledef.stringGapLo = LOWORD(value);
22295 _fretstyledef.stringGapHi = HIWORD(value);
22304 _fretstyledef.stringWidthLo = LOWORD(value);
22305 _fretstyledef.stringWidthHi = HIWORD(value);
22314 _fretstyledef.fretGapLo = LOWORD(value);
22315 _fretstyledef.fretGapHi = HIWORD(value);
22324 _fretstyledef.fretWidthLo = LOWORD(value);
22325 _fretstyledef.fretWidthHi = HIWORD(value);
22334 _fretstyledef.nutWidthLo = LOWORD(value);
22335 _fretstyledef.nutWidthHi = HIWORD(value);
22344 _fretstyledef.horzFingNumOffLo = LOWORD(value);
22345 _fretstyledef.horzFingNumOffHi = HIWORD(value);
22354 _fretstyledef.vertFingNumOffLo = LOWORD(value);
22355 _fretstyledef.vertFingNumOffHi = HIWORD(value);
22364 _fretstyledef.whiteoutLo = LOWORD(value);
22365 _fretstyledef.whiteoutHi = HIWORD(value);
22374 _fretstyledef.horzHandleOffLo = LOWORD(value);
22375 _fretstyledef.horzHandleOffHi = HIWORD(value);
22384 _fretstyledef.vertHandleOffLo = LOWORD(value);
22385 _fretstyledef.vertHandleOffHi = HIWORD(value);
22396 if (!pString)
return;
22397 memset(&_fretstyledef.fretNumText, 0,
sizeof(_fretstyledef.fretNumText));
22398#if FXT_VERSION >= FINALEVERSION_25
22401 strncpy(_fretstyledef.fretNumText, pString->
GetCString(),
sizeof(_fretstyledef.fretNumText) - 1);
22411 _fretstyledef.horzTextOffLo = LOWORD(value);
22412 _fretstyledef.horzTextOffHi = HIWORD(value);
22421 _fretstyledef.vertTextOffLo = LOWORD(value);
22422 _fretstyledef.vertTextOffHi = HIWORD(value);
22457 _fretstyledef.fingStrShapeID = value;
22466 _fretstyledef.openStrShapeID = value;
22475 _fretstyledef.muteStrShapeID = value;
22484 _fretstyledef.barreShapeID = value;
22493 _fretstyledef.customShapeID = value;
22504 if (!pFontInfo)
return;
22505 _fretstyledef.fingNumFontID = pFontInfo->
GetIDByName();
22506 _fretstyledef.fingNumFontSize = pFontInfo->
GetSize();
22518 if (!pFontInfo)
return;
22519 _fretstyledef.fretNumFontID = pFontInfo->
GetIDByName();
22520 _fretstyledef.fretNumFontSize = pFontInfo->
GetSize();
22524#ifdef PDK_FRAMEWORK_DEBUG
22536#if FXT_VERSION >= FINALEVERSION_2012
22541#ifndef DOXYGEN_SHOULD_IGNORE_THIS
22544 EDTFretGroup2012 _fretgroup;
22547 EXTAG
Tag()
const override {
return otx_FretGroup; }
22548 int DataSizeLoad()
const override {
return sizeof(EDTFretGroup2012); }
22549 void*
Allocate()
override {
return (
void*) &_fretgroup; }
22550 EVERSION
EnigmaVersion()
const override {
return FINALEVERSION_2012; }
22566 const char*
ClassName()
const override {
return "FCFretboardGroupDef"; }
22569#ifndef DOXYGEN_SHOULD_IGNORE_THIS
22576 void* _GetDataPtr() {
return &_fretgroup; }
22599#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
22601 luabridge::RefCountedPtr<FCFretInstrumentDef> CreateFretInstrumentDef_GC()
22613#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
22615 luabridge::RefCountedPtr<FCFretboardGroup> CreateFretboardGroup_GC()
22643#ifdef PDK_FRAMEWORK_DEBUG
22670#ifndef DOXYGEN_SHOULD_IGNORE_THIS
22674 EXTAG
Tag()
const override {
return ot_EndingRepeat; }
22676 void _AllocateMemory(
int size);
22688 const char*
ClassName()
const override {
return "FCEndingRepeat"; }
22691#ifndef DOXYGEN_SHOULD_IGNORE_THIS
22696 EDTEndingRepeat2005* _TypeCast()
const {
return (EDTEndingRepeat2005*)
_datablock; }
22705 _AllocateMemory(
sizeof(EDTEndingRepeat2005));
22736 return GetBitFlag(_TypeCast()->flag, EndRepeat_JMPIGNORE);
22745 return _TypeCast()->nextend;
22754 return GetBitFlag(_TypeCast()->flag, EndRepeat_INDIVPLAC);
22766 return !
GetBitFlag(_TypeCast()->flag, 0x0004);
22775 return _TypeCast()->line2;
22784 return _TypeCast()->pos;
22793 return _TypeCast()->line;
22802 return _TypeCast()->pos2;
22811 return _TypeCast()->endline;
22820 return _TypeCast()->textpos;
22829 return _TypeCast()->textline;
22838#ifndef PDK_FRAMEWORK_LUAFRIENDLY
22859#ifndef PDK_FRAMEWORK_LUAFRIENDLY
22866 switch (_TypeCast()->flag & EndRepeat_ACTION_BITS)
22887 if (list < 0)
return;
22888 _TypeCast()->staffList = list;
22889 Set16BitFlag(&_TypeCast()->flag, EndRepeat_TOPSTAFFONLY,
false);
22898 Set16BitFlag(&_TypeCast()->flag, EndRepeat_JMPIGNORE, state);
22908 _TypeCast()->nextend = measure;
22917 Set16BitFlag(&_TypeCast()->flag, EndRepeat_INDIVPLAC, state);
22935 _TypeCast()->line2 = position;
22944 _TypeCast()->pos = position;
22953 _TypeCast()->line = position;
22962 _TypeCast()->pos2 = position;
22971 _TypeCast()->endline = position;
22980 _TypeCast()->textpos = position;
22989 _TypeCast()->textline = position;
23000#ifndef PDK_FRAMEWORK_LUAFRIENDLY
23018#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
23020 luabridge::RefCountedPtr<FCString> CreateTextString_GC()
23067#ifndef PDK_FRAMEWORK_LUAFRIENDLY
23078 _TypeCast()->flag &= ~EndRepeat_ACTION_BITS;
23079 _TypeCast()->flag |= 0x10;
23082 _TypeCast()->flag &= ~EndRepeat_ACTION_BITS;
23083 _TypeCast()->flag |= 0x20;
23086 _TypeCast()->flag &= ~EndRepeat_ACTION_BITS;
23087 _TypeCast()->flag |= 0x50;
23090 _TypeCast()->flag &= ~EndRepeat_ACTION_BITS;
23116#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
23118 luabridge::RefCountedPtr<FCSeparatePlacements> CreateSeparatePlacements_GC()
23138#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
23140 luabridge::RefCountedPtr<FCSeparatePlacements> CreateTextSeparatePlacements_GC()
23158#ifndef DOXYGEN_SHOULD_IGNORE_THIS
23163 EDTBackwardRepeat2005 _backwardrepeat;
23166 EXTAG
Tag()
const override {
return ot_BackwardRepeat; }
23167 int DataSizeLoad()
const override {
return sizeof(EDTBackwardRepeat2005); }
23168 void*
Allocate()
override {
return (
void*) &_backwardrepeat; }
23176 memcpy(&_backwardrepeat, ((
FCBackwardRepeat*)pSource)->_GetBackwardRepeat(),
sizeof(_backwardrepeat));
23185 const char*
ClassName()
const override {
return "FCBackwardRepeat"; }
23188#ifndef DOXYGEN_SHOULD_IGNORE_THIS
23195 void* _GetBackwardRepeat() {
return &_backwardrepeat; }
23204 memset(&_backwardrepeat, 0,
sizeof(_backwardrepeat));
23216 return _backwardrepeat.target;
23225 return GetBitFlag(_backwardrepeat.flag, BackRepeat_INDIVPLAC);
23237 return !
GetBitFlag(_backwardrepeat.flag, 0x4000);
23247 return _backwardrepeat.actuate;
23256 return _backwardrepeat.line2;
23265 return _backwardrepeat.line1;
23274 return _backwardrepeat.pos1;
23283 return _backwardrepeat.pos2;
23292 return _backwardrepeat.staffList;
23301#ifndef PDK_FRAMEWORK_LUAFRIENDLY
23320#ifndef PDK_FRAMEWORK_LUAFRIENDLY
23330 Set16BitFlag(&_backwardrepeat.flag, BackRepeat_TOPSTAFFONLY,
true);
23331 _backwardrepeat.staffList = 0;
23334 Set16BitFlag(&_backwardrepeat.flag, BackRepeat_TOPSTAFFONLY,
false);
23335 if (!_backwardrepeat.staffList) _backwardrepeat.staffList = 1;
23338 Set16BitFlag(&_backwardrepeat.flag, BackRepeat_TOPSTAFFONLY,
false);
23339 _backwardrepeat.staffList = 0;
23351 _backwardrepeat.target = measure;
23360 return Set16BitFlag(&_backwardrepeat.flag, BackRepeat_INDIVPLAC, state);
23369 return Set16BitFlag(&_backwardrepeat.flag, 0x4000, !state);
23379 _backwardrepeat.actuate = passes;
23391#ifndef PDK_FRAMEWORK_LUAFRIENDLY
23398 switch (_backwardrepeat.flag & BackRepeat_ACTION_BITS)
23417 return GetBitFlag(_backwardrepeat.flag, BackRepeat_CLRonCHANGE);
23426 _backwardrepeat.line2 = position;
23435 _backwardrepeat.line1 = position;
23444 _backwardrepeat.pos1 = position;
23453 _backwardrepeat.pos2 = position;
23462 _backwardrepeat.staffList = stafflistid;
23474#ifndef PDK_FRAMEWORK_LUAFRIENDLY
23485 _backwardrepeat.flag &= ~BackRepeat_ACTION_BITS;
23486 _backwardrepeat.flag |= 0x10;
23489 _backwardrepeat.flag &= ~BackRepeat_ACTION_BITS;
23490 _backwardrepeat.flag |= 0x20;
23493 _backwardrepeat.flag &= ~BackRepeat_ACTION_BITS;
23509 Set16BitFlag(&_backwardrepeat.flag, BackRepeat_CLRonCHANGE, state);
23520#ifndef PDK_FRAMEWORK_LUAFRIENDLY
23527 switch (_backwardrepeat.flag & 0xc00)
23539#ifdef PDK_FRAMEWORK_DEBUG
23540 DebugOutHex(
"Undefined flag state for FCBackwardRepeat:GetAction: ", _backwardrepeat.flag);
23554#ifndef PDK_FRAMEWORK_LUAFRIENDLY
23600#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
23602 luabridge::RefCountedPtr<FCSeparatePlacements> CreateSeparatePlacements_GC()
23617#ifndef DOXYGEN_SHOULD_IGNORE_THIS
23619 struct __FCEDTBeatChartHeader
23621 TimeEdu32 totalDur;
23631 EDTBeatChartElement _beatchartelement;
23633 const __FCEDTBeatChartHeader* _GetDataAsHeader()
const
23634 {
return reinterpret_cast<const __FCEDTBeatChartHeader*
>(&_beatchartelement); }
23636 __FCEDTBeatChartHeader* _GetDataAsHeader()
23637 {
return reinterpret_cast<__FCEDTBeatChartHeader*
>(&_beatchartelement); }
23640 EXTAG
Tag()
const override {
return ot_BeatChartElement; }
23641 int DataSizeLoad()
const override {
return sizeof(EDTBeatChartElement); }
23642 void*
Allocate()
override {
return (
void*) &_beatchartelement; }
23650 memcpy(&_beatchartelement, ((
FCBeatChartElement*)pSource)->_GetBeatChartElement(),
sizeof(_beatchartelement));
23659 const char*
ClassName()
const override {
return "FCBeatChartElement"; }
23662#ifndef DOXYGEN_SHOULD_IGNORE_THIS
23669 void* _GetBeatChartElement() {
return &_beatchartelement; }
23679 memset(&_beatchartelement, 0,
sizeof(_beatchartelement));
23722 return _beatchartelement.nextposi;
23737 return _beatchartelement.minpos;
23753 return _GetDataAsHeader()->totalDur;
23768 return _GetDataAsHeader()->totalWidth;
23786 return _GetDataAsHeader()->minWidth;
23804 return _GetDataAsHeader()->allotWidth;
23854 _beatchartelement.nextposi = width + _beatchartelement.posi;
23866 _beatchartelement.posi = position;
23880 _beatchartelement.nextposi = value;
23896 _beatchartelement.minpos = value;
23908 _GetDataAsHeader()->totalDur = dura;
23920 _GetDataAsHeader()->totalWidth = span;
23935 _GetDataAsHeader()->minWidth = width;
23947 _GetDataAsHeader()->allotWidth = width;
23966#ifdef PDK_FRAMEWORK_DEBUG
23989#ifndef DOXYGEN_SHOULD_IGNORE_THIS
23996 EXTAG
Tag()
const override {
return ot_Tempo; }
23997 int DataSizeLoad()
const override {
return sizeof(EDTTempo); }
23998 void*
Allocate()
override {
return (
void*) &_tempo; }
24006 memcpy(&_tempo, ((
FCTempoElement*)pSource)->_GetTempoElement(),
sizeof(_tempo));
24015 const char*
ClassName()
const override {
return "FCTempoElement"; }
24018#ifndef DOXYGEN_SHOULD_IGNORE_THIS
24025 void* _GetTempoElement() {
return &_tempo; }
24034 memset(&_tempo, 0,
sizeof(_tempo));
24035 _tempo.unit = 1000;
24067 _tempo.flag = value ? TIMEDIAL_ABSOLUTE : TIMEDIAL_RELATIVE;
24096 float result = _tempo.ratio * _tempo.unit;
24102 fourbyte fb = (fourbyte) (result * 100);
24125 _tempo.unit = 1000;
24130 _tempo.ratio = (fourbyte) value;
24142 SetRatio((fourbyte) (value * 10));
24148#ifdef PDK_FRAMEWORK_TINYXML
24158 PERC_NOTE_TYPE _notetype;
24167 PERCNOTETYPE_BASSDRUM = 13,
24168 PERCNOTETYPE_BELLTREE = 70,
24169 PERCNOTETYPE_BONGO_HIGH = 32,
24170 PERCNOTETYPE_BONGO_LOW = 33,
24171 PERCNOTETYPE_CONGA = 36,
24172 PERCNOTETYPE_COWBELL = 6,
24173 PERCNOTETYPE_CASTANETS = 362,
24174 PERCNOTETYPE_CYMBAL_CHINA = 17,
24175 PERCNOTETYPE_CYMBAL_CRASH = 4,
24176 PERCNOTETYPE_CYMBAL_RIDE = 18,
24177 PERCNOTETYPE_CYMBAL_SIZZLE = 121,
24178 PERCNOTETYPE_CYMBAL_SPLASH = 21,
24179 PERCNOTETYPE_CLAVES = 35,
24180 PERCNOTETYPE_GONG_SMALL = 137,
24181 PERCNOTETYPE_GONG_MEDIUM = 136,
24182 PERCNOTETYPE_GONG_LARGE = 135,
24183 PERCNOTETYPE_HIHAT_CLOSED = 15,
24184 PERCNOTETYPE_HIHAT_FOOT = 16,
24185 PERCNOTETYPE_HIHAT_OPEN = 14,
24186 PERCNOTETYPE_KICKDRUM = 2,
24187 PERCNOTETYPE_RHYTHMCUES = 235,
24188 PERCNOTETYPE_ROTOTOM_MID = 321,
24189 PERCNOTETYPE_SIDEDRUM = 279,
24190 PERCNOTETYPE_SNAREDRUM = 1,
24191 PERCNOTETYPE_TAMBOURINE = 7,
24192 PERCNOTETYPE_TAMTAM = 149,
24193 PERCNOTETYPE_TOM_HIGH = 24,
24194 PERCNOTETYPE_TOM_HIGHMID = 25,
24195 PERCNOTETYPE_TOM_LOW = 27,
24196 PERCNOTETYPE_TRIANGLE_MUTE = 8,
24197 PERCNOTETYPE_TRIANGLE_OPEN = 9,
24198 PERCNOTETYPE_VIBRASLAP = 12,
24199 PERCNOTETYPE_WINDCHIMES = 460,
24200 PERCNOTETYPE_WOODBLOCK_HIGH = 10
24206 _midikey = midikey;
24207 _notetype = notetype;
24210 const char*
ClassName()
const override {
return "FCPercussionMapNote"; }
24233 twobyte returnvalue = _notetype & 0xf000;
24234 returnvalue /= 0x1000;
24235 return returnvalue;
24261 twobyte _percussionid;
24271 _percussionid = percussionid;
24277 const char*
ClassName()
const override {
return "FCPercussionMapNotes"; }
24293 for (
int i = 0; i <
GetCount(); i++)
24309 for (
int i = 0; i <
GetCount(); i++)
24312 if (pItem->
GetMidiNote() == midinote)
return pItem;
24330 const char*
ClassName()
const override {
return "FCPercussionMapNotesLookup"; }
24366 const char*
ClassName()
const override {
return "FCPercussionLayoutNotesLookup"; }
24415#ifndef DOXYGEN_SHOULD_IGNORE_THIS
24417 EDTInstDefinition _instrumentdef;
24420 EXTAG
Tag()
const override {
return ot_InstDefinition; }
24421 int DataSizeLoad()
const override {
return sizeof(EDTInstDefinition); }
24422 void*
Allocate()
override {
return (
void*) &_instrumentdef; }
24430 memcpy(&_instrumentdef, ((
FCInstrumentDef*)pSource)->_GetInstrumentDef(),
sizeof(_instrumentdef));
24439 const char*
ClassName()
const override {
return "FCInstrumentDef"; }
24442#ifndef DOXYGEN_SHOULD_IGNORE_THIS
24449 void* _GetInstrumentDef() {
return &_instrumentdef; }
24477#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
24479 luabridge::RefCountedPtr<FCString> CreateNameString_GC()
24505#ifdef PDK_FRAMEWORK_TINYXML
24521#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
24523 luabridge::RefCountedPtr<FCPercussionMapNotes> CreatePercussionMapNotes_GC()
24535#ifdef PDK_FRAMEWORK_DEBUG
24545#ifndef DOXYGEN_SHOULD_IGNORE_THIS
24547#include "pragma_align_begin.h"
24548struct __EDTLayerPlayData
24550 ePlaybackRoute playbackRouteNum;
24551 twobyte velControlLevel;
24552 FLAG_16 velControlSaveFlags;
24555#include "pragma_align_end.h"
24557#include "pragma_align_begin.h"
24558struct __EDTPlayData2006
24560 __EDTLayerPlayData chordPlayData;
24561 __EDTLayerPlayData MIDIExpressionsPlayData;
24562 __EDTLayerPlayData layerPlayData[4];
24564#include "pragma_align_end.h"
24566const EXTAG __ot_PlayData2006 = MAKEEXTAG(edOther4Inci,
'P',
'L');
24569const FLAG_16 __PLAY_LAYER_TRACK = 0x0001;
24570const FLAG_16 __SOLO_LAYER_TRACK = 0x0002;
24587 __EDTLayerPlayData* _pLayerData;
24595 _pLayerData = pData;
24597 const char*
ClassName()
const override {
return "FCLayerPlaybackData"; }
24607 return _pLayerData->playbackRouteNum + 1;
24616 return GetBitFlag(_pLayerData->playFlags, __PLAY_LAYER_TRACK);
24625 return GetBitFlag(_pLayerData->playFlags, __SOLO_LAYER_TRACK);
24638 _pLayerData->playbackRouteNum = value - 1;
24647 return Set16BitFlag(&_pLayerData->playFlags, __PLAY_LAYER_TRACK, state);
24656 return Set16BitFlag(&_pLayerData->playFlags, __SOLO_LAYER_TRACK, state);
24670#ifndef DOXYGEN_SHOULD_IGNORE_THIS
24672 __EDTPlayData2006 _playbackdata;
24674 std::unique_ptr<FCLayerPlaybackData> _pChordLayer;
24675 std::unique_ptr<FCLayerPlaybackData> _pExpressionLayer;
24676 std::vector<std::unique_ptr<FCLayerPlaybackData>> _pNoteLayers;
24679 EXTAG
Tag()
const override {
return __ot_PlayData2006; }
24680 int DataSizeLoad()
const override {
return sizeof(__EDTPlayData2006); }
24681 void*
Allocate()
override {
return (
void*) &_playbackdata; }
24698 const char*
ClassName()
const override {
return "FCInstrumentPlaybackData"; }
24701#ifndef DOXYGEN_SHOULD_IGNORE_THIS
24708 void* _GetPlaybackData() {
return &_playbackdata; }
24738 _pChordLayer = std::make_unique<FCLayerPlaybackData>(
FCLayerPlaybackData(&_playbackdata.chordPlayData));
24739 return _pChordLayer.get();
24760 if (!_pExpressionLayer)
24761 _pExpressionLayer = std::make_unique<FCLayerPlaybackData>(
FCLayerPlaybackData(&_playbackdata.MIDIExpressionsPlayData));
24762 return _pExpressionLayer.get();
24784 if ((layernumber < 1) || (layernumber > _pNoteLayers.size()))
return NULL;
24787 if (!_pNoteLayers[layernumber])
24788 _pNoteLayers[layernumber] = std::make_unique<FCLayerPlaybackData>(
FCLayerPlaybackData(&_playbackdata.layerPlayData[layernumber]));
24789 return _pNoteLayers[layernumber].get();
24792#ifdef PDK_FRAMEWORK_DEBUG
24813#ifndef DOXYGEN_SHOULD_IGNORE_THIS
24815 EDTPercussionNoteDef2010 _percussionnotedef2010;
24816#if FXT_VERSION >= FINALEVERSION_2012
24817 EDTPercussionNoteDef2012 _percussionnotedef2012;
24824 EVERSION _VersionToUse()
const;
24827 EXTAG
Tag()
const override;
24848 const char*
ClassName()
const override {
return "FCPercussionLayoutNote"; }
24851#ifndef DOXYGEN_SHOULD_IGNORE_THIS
24858 void* _GetPercussionNoteDef();
24981#ifdef PDK_FRAMEWORK_TINYXML
25002#ifdef PDK_FRAMEWORK_DEBUG
25014const EXTAG __ot_CategoryStaffListScore = MAKEEXTAG(edOther,
'C',
's');
25015const EXTAG __ot_CategoryStaffListParts = MAKEEXTAG(edOther,
'C',
'p');
25016const EXTAG __ot_CategoryStaffListScoreOverride = MAKEEXTAG(edOther,
'c',
25018const EXTAG __ot_CategoryStaffListPartsOverride = MAKEEXTAG(edOther,
'C',
25022const EXTAG __ot_StaffAssignStaffListScore = MAKEEXTAG(edOther,
'S',
's');
25023const EXTAG __ot_StaffAssignStaffListParts = MAKEEXTAG(edOther,
's',
'p');
25024const EXTAG __ot_StaffAssignStaffListScoreOverride = MAKEEXTAG(edOther,
'S',
25026const EXTAG __ot_StaffAssignStaffListPartsOverride = MAKEEXTAG(edOther,
's',
25044#ifndef DOXYGEN_SHOULD_IGNORE_THIS
25045 EDTStaffList* _TypeCast()
const {
return (EDTStaffList*)
_datablock; }
25048#ifndef DOXYGEN_SHOULD_IGNORE_THIS
25073 SLMODE_CATEGORY_SCORE,
25074 SLMODE_CATEGORY_PARTS,
25075 SLMODE_CATEGORY_FORCESCORE,
25076 SLMODE_CATEGORY_FORCEPARTS,
25078 SLMODE_ASSIGNMENT_SCORE,
25079 SLMODE_ASSIGNMENT_PARTS,
25080 SLMODE_ASSIGNMENT_FORCESCORE,
25081 SLMODE_ASSIGNMENT_FORCEPARTS
25093 const char*
ClassName()
const override {
return "FCStaffList"; }
25096#ifndef DOXYGEN_SHOULD_IGNORE_THIS
25103 void* _GetStaffListElement() {
return _datablock; }
25127#ifndef PDK_FRAMEWORK_LUAFRIENDLY
25143 case SLMODE_FORCESCORE:
25146 case SLMODE_FORCEPARTS:
25150 case SLMODE_CATEGORY_SCORE:
25153 case SLMODE_CATEGORY_PARTS:
25156 case SLMODE_CATEGORY_FORCESCORE:
25159 case SLMODE_CATEGORY_FORCEPARTS:
25163 case SLMODE_ASSIGNMENT_SCORE:
25166 case SLMODE_ASSIGNMENT_PARTS:
25169 case SLMODE_ASSIGNMENT_FORCESCORE:
25172 case SLMODE_ASSIGNMENT_FORCEPARTS:
25178#ifdef PDK_FRAMEWORK_DEBUG
25186 bool Load(CMPER itemno)
override;
25192 bool Save()
override;
25208 int maxcount =
_loadedsize /
sizeof(EDTStaffList);
25210 while (maxcount > 0)
25212 if (_TypeCast()[maxcount - 1].staff == 0)
25228 int maxcount =
_loadedsize /
sizeof(EDTStaffList);
25229 int staffcount = 0;
25230 for (
int i = 0; i < maxcount; i++)
25232 if (_TypeCast()[i].staff > 0) staffcount++;
25248 if (index < 0)
return 0;
25249 int maxcount =
_loadedsize /
sizeof(EDTStaffList);
25250 int staffcount = 0;
25251 for (
int i = 0; i < maxcount; i++)
25253 if (_TypeCast()[i].staff > 0)
25255 if (staffcount == index)
return _TypeCast()[index].staff;
25268 if (stafflistelement == 0)
return false;
25269 int maxcount =
_loadedsize /
sizeof(EDTStaffList);
25270 for (
int i = 0; i < maxcount; i++)
25272 if (_TypeCast()[i].staff == stafflistelement)
return true;
25318#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
25320 luabridge::RefCountedPtr<FCString> CreateNameString_GC()
25350 if (staffnumber < 1)
return false;
25414 if (staffnumber < 1)
return false;
25429#ifndef DOXYGEN_SHOULD_IGNORE_THIS
25430 EDTFretInstrument _fretinstrumentold;
25432 FIN25_3_CODE( EDTFretInstrument25_3 _fretinstrument25_3; )
25436 bool _Use25_3Version()
const;
25439 const twobyte* _GetNoOfFretsPtr()
const
25441 FIN25_3_CODE(
if (_Use25_3Version())
return &_fretinstrument25_3.noOfFrets; )
25442 return &_fretinstrumentold.noOfFrets;
25446 const twobyte* _GetNoOfStringsPtr()
const
25448 FIN25_3_CODE(
if (_Use25_3Version())
return &_fretinstrument25_3.noOfStrings; )
25449 return &_fretinstrumentold.noOfStrings;
25453 const eClef* _GetSpeedyClefPtr()
const
25455 FIN25_3_CODE(
if (_Use25_3Version())
return &_fretinstrument25_3.speedyClef; )
25456 return &_fretinstrumentold.speedyClef;
25460 const utwobyte* _GetDiatonicStepsLoPtr()
const
25462 FIN25_3_CODE(
if (_Use25_3Version())
return &_fretinstrument25_3.diatonicStepsLo; )
25463 return &_fretinstrumentold.diatonicStepsLo;
25467 const utwobyte* _GetDiatonicStepsHiPtr()
const
25469 FIN25_3_CODE(
if (_Use25_3Version())
return &_fretinstrument25_3.diatonicStepsHi; )
25470 return &_fretinstrumentold.diatonicStepsHi;
25475 const void* _GetNamePtr()
const
25477 FIN25_3_CODE(
if (_Use25_3Version())
return &_fretinstrument25_3.name; )
25478 return &_fretinstrumentold.name;
25483 const void* _GetStringTuningPtr(
int stringno)
const
25485 FIN25_3_CODE(
if (_Use25_3Version())
return &_fretinstrument25_3.stringTuning[stringno - 1]; )
25486 return &_fretinstrumentold.stringTuning[stringno - 1];
25491#ifndef DOXYGEN_SHOULD_IGNORE_THIS
25493 EXTAG
Tag()
const override;
25496 EVERSION
EnigmaVersion()
const override {
return _Use25_3Version() ? FINALEVERSION_25_3 : FINALEVERSION_2010; }
25507 memcpy(_GetFretInstrumentDef(), ((
FCFretInstrumentDef*)pSource)->_GetFretInstrumentDef(), size);
25516 const char*
ClassName()
const override {
return "FCFretInstrumentDef"; }
25529#ifndef DOXYGEN_SHOULD_IGNORE_THIS
25536 void* _GetFretInstrumentDef() {
return Allocate(); }
25546 if (_Use25_3Version())
25548#if FXT_VERSION >= FINALEVERSION_25_3
25549 memset(&_fretinstrument25_3, 0,
sizeof(_fretinstrument25_3));
25556 memset(&_fretinstrumentold, 0,
sizeof(_fretinstrumentold));
25568 return *_GetNoOfFretsPtr();
25577 *(twobyte*)_GetNoOfFretsPtr() = count;
25586 return *_GetNoOfStringsPtr();
25597 if (count < 1)
return;
25598 if (count > 24)
return;
25599 *(twobyte*)_GetNoOfStringsPtr() = count;
25608 return *_GetSpeedyClefPtr();
25617 *(eClef*)_GetSpeedyClefPtr() = clef;
25632 if (!pString)
return false;
25633 if (_Use25_3Version())
25641 pString->
SetCString((ECHAR*) _GetNamePtr());
25659 if (!pString)
return false;
25660 if (pString->
GetLength() > 47)
return false;
25661 if (_Use25_3Version())
25669 strcpy((ECHAR*) _GetNamePtr(), pString->
GetCString());
25686 if (stringnumber < 1)
return 0;
25688 if (stringnumber > 24)
return 0;
25692#if FXT_VERSION >= FINALEVERSION_25_3
25693 if (_Use25_3Version())
25695 return ((EDTStringData*)_GetStringTuningPtr(stringnumber))->pitch;
25698 return *(twobyte*)_GetStringTuningPtr(stringnumber);
25714 if (stringnumber < 1)
return false;
25716 if (stringnumber > 24)
return false;
25718 if (_Use25_3Version())
25720#if FXT_VERSION >= FINALEVERSION_25_3
25721 ((EDTStringData*)_GetStringTuningPtr(stringnumber))->pitch = midinumber;
25726 *(twobyte*)_GetStringTuningPtr(stringnumber) = midinumber;
25737 return (MAKELONG(*_GetDiatonicStepsLoPtr(), *_GetDiatonicStepsHiPtr()) != 0);
25747 ufourbyte fb = MAKELONG(*_GetDiatonicStepsLoPtr(), *_GetDiatonicStepsHiPtr());
25748 int totalcount = 0;
25751 if (fb & 0x01) totalcount ++;
25766 if (!pNumbers)
return false;
25768 ufourbyte fb = MAKELONG(*_GetDiatonicStepsLoPtr(), *_GetDiatonicStepsHiPtr());
25792 if (!pNumbers)
return false;
25794 for (
int i = pNumbers->
GetCount() - 1; i >= 0; i--)
25797 if (pNumber->
GetInt() < 1)
return false;
25798 if (pNumber->
GetInt() > 5)
return false;
25801 for (
int bitcount = 0; bitcount < pNumber->
GetInt() - 1; bitcount++)
25806 *(utwobyte*)_GetDiatonicStepsLoPtr() = LOWORD(fb);
25807 *(utwobyte*)_GetDiatonicStepsHiPtr() = HIWORD(fb);
25812#ifdef PDK_FRAMEWORK_DEBUG
25816 DebugOutHex(
"Diatonic bit set: ", MAKELONG(*_GetDiatonicStepsLoPtr(), *_GetDiatonicStepsHiPtr()));
25822#ifndef DOXYGEN_SHOULD_IGNORE_THIS
25823#include "pragma_align_begin.h"
25828 twobyte vertadjust;
25830 twobyte horizadjust;
25833#include "pragma_align_end.h"
25835const EXTAG __ot_MidClef = MAKEEXTAG(edOther,
'C',
'E');
25852#ifndef DOXYGEN_SHOULD_IGNORE_THIS
25853 __EDTMidClef _midclefdata;
25858 _midclefdata = src._midclefdata;
25866#ifndef DOXYGEN_SHOULD_IGNORE_THIS
25868 EXTAG
Tag()
const override {
return __ot_MidClef; }
25869 int DataSizeLoad()
const override {
return sizeof(__EDTMidClef); }
25870 void*
Allocate()
override {
return (
void*) &_midclefdata; }
25874 memcpy(&_midclefdata, ((
FCCellClefChange*)pSource)->_GetCellClefChange(),
sizeof(_midclefdata));
25883 const char*
ClassName()
const override {
return "FCCellClefChange"; }
25886#ifndef DOXYGEN_SHOULD_IGNORE_THIS
25893 void* _GetCellClefChange() {
return Allocate(); }
26044 _position = position;
26067#ifndef DOXYGEN_SHOULD_IGNORE_THIS
26069const EXTAG __ot_MetatoolExpression = MAKEEXTAG(edOther,
'&',
'd');
26070const EXTAG __ot_MetatoolArticulation = MAKEEXTAG(edOther,
'&',
'a');
26071const EXTAG __ot_MetatoolRepeat = MAKEEXTAG(edOther,
'&',
'r');
26072const EXTAG __ot_MetatoolClef = MAKEEXTAG(edOther,
'&',
'f');
26073const EXTAG __ot_MetatoolTuplet = MAKEEXTAG(edOther3Inci,
'&',
'u');
26074const EXTAG __ot_MetatoolStaffStyle = MAKEEXTAG(edOther,
'&',
's');
26076#include "pragma_align_begin.h"
26077struct __EDTMetatool
26086#include "pragma_align_end.h"
26091#ifdef PDK_FRAMEWORK_ENTRIES
26117 MTOOLMODE_UNKNOWN = 0,
26131#ifdef PDK_FRAMEWORK_ENTRIES
26141#ifndef DOXYGEN_SHOULD_IGNORE_THIS
26144 __EDTMetatool _metatool;
26145 EDTTuplet2005 _tupletmetatool;
26149#ifndef DOXYGEN_SHOULD_IGNORE_THIS
26151 EXTAG
Tag()
const override
26156 return __ot_MetatoolExpression;
26158 return __ot_MetatoolArticulation;
26160 return __ot_MetatoolRepeat;
26162 return __ot_MetatoolClef;
26163#ifdef PDK_FRAMEWORK_ENTRIES
26165 return __ot_MetatoolTuplet;
26168 return __ot_MetatoolStaffStyle;
26169 case MTOOLMODE_UNKNOWN:
26178#ifdef PDK_FRAMEWORK_ENTRIES
26180 return sizeof(_tupletmetatool);
26182 case MTOOLMODE_UNKNOWN:
26185 return sizeof(__EDTMetatool);
26192#ifdef PDK_FRAMEWORK_ENTRIES
26194 return (
void*) &_tupletmetatool;
26196 case MTOOLMODE_UNKNOWN:
26199 return (
void*) &_metatool;
26211 if (_mode == MTOOLMODE_UNKNOWN)
return;
26221 const char*
ClassName()
const override {
return "FCMetatoolAssignment"; }
26224#ifndef DOXYGEN_SHOULD_IGNORE_THIS
26231 void* _GetMetatool() {
return Allocate(); }
26240 _mode = MTOOLMODE_UNKNOWN;
26242 memset(&_metatool, 0,
sizeof(_metatool));
26243 memset(&_tupletmetatool, 0,
sizeof(_tupletmetatool));
26256#ifndef PDK_FRAMEWORK_LUAFRIENDLY
26263 if (_mode != MTOOLMODE_UNKNOWN)
return;
26275#ifndef PDK_FRAMEWORK_LUAFRIENDLY
26309 return _metatool.item1;
26334 return (_metatool.item2 == 0);
26347 if (!pDef)
return false;
26363 if (!pDef)
return false;
26366 _metatool.item2 = 1;
26380 if (!pDef)
return false;
26383 _metatool.item2 = 0;
26397 if (!pDef)
return false;
26413#ifdef PDK_FRAMEWORK_ENTRIES
26435 if (!pStaffStyle)
return false;
26437 _metatool.item1 = pStaffStyle->
GetItemNo();
26449 if (_mode == MTOOLMODE_UNKNOWN)
return false;
26450 if ((keystrokeslot >=
'A' && keystrokeslot <=
'Z') || (keystrokeslot >=
'0' && keystrokeslot <=
'9'))
26462 virtual bool SaveAs([[maybe_unused]]CMPER cmper)
override {
return false; }
26483#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
26485 luabridge::RefCountedPtr<__FCBaseData> CreateLinkedObject_GC()
26489#ifdef PDK_FRAMEWORK_DEBUG
26495#ifdef PDK_FRAMEWORK_ENTRIES
26514#ifdef PDK_FRAMEWORK_ENIGMASTRINGS
26528#ifndef DOXYGEN_SHOULD_IGNORE_THIS
26530 EDTBookmark2012 _bookmark;
26533 EXTAG
Tag()
const override {
return ot_Bookmark2012; }
26534 int DataSizeLoad()
const override {
return sizeof(_bookmark); }
26535 void*
Allocate()
override {
return (
void*) &_bookmark; }
26555#ifndef DOXYGEN_SHOULD_IGNORE_THIS
26562 void* _GetBookmark() {
return &_bookmark; }
26572 bool Save()
override;
26614 if (! text.
Load(_bookmark.nameRawTextID))
26621#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
26623 luabridge::RefCountedPtr<FCString> CreateNameString_GC()
26649#ifndef PDK_FRAMEWORK_LUAFRIENDLY
26707 return static_cast<utwobyte
>(_bookmark.vertpos_staffset) - IU_STAFFSET1 + 1;
26708 return _bookmark.vertpos_staffset;
26725#ifndef PDK_FRAMEWORK_LUAFRIENDLY
26730 value) { _bookmark.view = (twobyte)value; }
26784 _bookmark.vertpos_staffset = IU_STAFFSET1 + value - 1;
26786 _bookmark.vertpos_staffset = value;
26813#ifdef PDK_FRAMEWORK_DEBUG
26824#ifndef DOXYGEN_SHOULD_IGNORE_THIS
26826#include "pragma_align_begin.h"
26827struct _FCEDTKeyFormat
26829 twobyte totalSteps;
26830 twobyte numDiatonicSteps;
26834#include "pragma_align_end.h"
26838#define __ot_KeyFormat MAKEEXTAG(edOther,'K','F')
26840#include "pragma_align_begin.h"
26841struct _FCEDTKeyAttributes
26843 twobyte harmonicRef;
26844 eMIDIkey middleKey;
26845 EFONTID symbolFont;
26846 twobyte gotoKeyUnit;
26851#define KEYSATTRIB_HAS_CLEFOCTV 0x0001
26853#include "pragma_align_end.h"
26857#define __ot_KeyAttributes MAKEEXTAG(edOther,'K','A')
26859#include "pragma_align_begin.h"
26860struct __FCEDTKeyStep
26862 twobyte diatonicStep;
26866#define KEYSTEP_IS_NEXT_DIATONIC_STEP 0x8000
26868#include "pragma_align_end.h"
26872#define __ot_KeyStepMap MAKEEXTAG(edOther,'K','M')
26877#define __dt_KeyAcciSymbol MAKEEXTAG(edDetail,'K','S')
26882#define __ot_KeyAcciOrderPositive MAKEEXTAG(edOther,'O','p')
26883#define __ot_KeyAcciOrderNegative MAKEEXTAG(edOther,'O','n')
26887#define __ot_KeyAcciAmountPositive MAKEEXTAG(edOther,'A','p')
26888#define __ot_KeyAcciAmountNegative MAKEEXTAG(edOther,'A','n')
26892#define __ot_KeyToneCenterPositive MAKEEXTAG(edOther,'T','p')
26893#define __ot_KeyToneCenterNegative MAKEEXTAG(edOther,'T','n')
26898#define __dt_KeyOctavePlacementPositive MAKEEXTAG(edDetail,'C','p')
26899#define __dt_KeyOctavePlacementNegative MAKEEXTAG(edDetail,'C','n')
26904template<EXTAG TAGP, EXTAG TAGN,
int MAXSIZE,
bool CONSTRAIN_VALUES>
26907 static_assert(MAXSIZE == 7 || MAXSIZE == 8,
"MAXSIZE must be 7 o 8");
26908 static constexpr bool IS_DETAIL = HI_UTWOBYTE(TAGP) == edDetail;
26911 using __FCPositiveArray = std::conditional_t<IS_DETAIL, __FCEnigmaDetailArray<twobyte, TAGP>, __FCEnigmaOtherArray<twobyte, TAGP>>;
26912 using __FCNegativeArray = std::conditional_t<IS_DETAIL, __FCEnigmaDetailArray<twobyte, TAGN>, __FCEnigmaOtherArray<twobyte, TAGN>>;
26914 __FCPositiveArray _positive;
26915 __FCNegativeArray _negative;
26918 twobyte __getActualX(twobyte x)
const
26920 twobyte actualX = std::abs(x);
26921 if constexpr (MAXSIZE == 7)
26925#ifdef PDK_FRAMEWORK_LUAFRIENDLY
26926 throw std::runtime_error(
"zero is not a valid index");
26933 if (actualX >= MAXSIZE)
26935#ifdef PDK_FRAMEWORK_LUAFRIENDLY
26936 throw std::runtime_error(
"index out of range: " + std::to_string(x));
26938 return actualX % MAXSIZE;
26944 __FCDualArray() : _positive(MAXSIZE), _negative(MAXSIZE)
26951 twobyte operator[](twobyte x)
const
26953 twobyte actualX = __getActualX(x);
26954 if (x < 0)
return _negative[actualX];
26955 return _positive[actualX];
26958 twobyte& operator[](twobyte x)
26960 twobyte actualX = __getActualX(x);
26961 if (x < 0)
return _negative[actualX];
26962 return _positive[actualX];
26965 int NumPositive()
const {
return _positive.NumElements(); }
26966 int NumNegative()
const {
return _negative.NumElements(); }
26968 __FCDualArray& operator=(
const std::map<twobyte, twobyte>& values)
26972 for (
auto value : values)
26974 if (value.first >= 0 && !NumPositive())
26975 _positive.AllocateFor(MAXSIZE);
26976 else if (value.first < 0 && !NumNegative())
26977 _negative.AllocateFor(MAXSIZE);
26978 if constexpr(CONSTRAIN_VALUES)
26980 if (value.second < 0 || value.second > 6)
26982#ifdef PDK_FRAMEWORK_LUAFRIENDLY
26983 throw std::runtime_error(
"value must be between 0 and 6: got " + std::to_string(value.second));
26985 (*this)[value.first] = std::abs(value.second) % 6;
26989 (*this)[value.first] = value.second;
26994 operator std::map<twobyte, twobyte>()
const
26996 std::map<twobyte, twobyte> values;
26997 const twobyte xoff = (MAXSIZE == 7) ? 1 : 0;
26998 for (twobyte x = 0; x < NumPositive(); x++)
27000 if (x >= MAXSIZE)
break;
27001 values[x + xoff] = _positive[x];
27003 const twobyte startneg = (MAXSIZE == 7) ? 0 : 1;
27004 for (twobyte x = startneg; x < NumNegative(); x++)
27006 if (x >= MAXSIZE)
break;
27007 values[-x - xoff] = _negative[x];
27012 bool Load(CMPER cmper, CMPER cmper2)
27014 bool retval =
false;
27015 if constexpr(IS_DETAIL)
27017 if (_positive.Load(cmper, cmper2)) retval =
true;
27018 if (_negative.Load(cmper, cmper2)) retval =
true;
27022 if (_positive.Load(cmper)) retval =
true;
27023 if (_negative.Load(cmper)) retval =
true;
27028 bool SaveAs(CMPER cmper, CMPER cmper2)
27030 if constexpr(IS_DETAIL)
27031 return _positive.SaveAs(cmper, cmper2) && _negative.SaveAs(cmper, cmper2);
27033 return _positive.SaveAs(cmper) && _negative.SaveAs(cmper);
27036 bool Delete(CMPER cmper)
27038 bool deleted =
false;
27039 if (__FCPositiveArray().Delete(cmper)) deleted =
true;
27040 if (__FCNegativeArray().Delete(cmper)) deleted =
true;
27045template<EXTAG TAGP, EXTAG TAGN,
int MAXSIZE,
bool CONSTRAIN_VALUES = true>
27046class __FCDualOtherArray :
public __FCDualArray<TAGP, TAGN, MAXSIZE, CONSTRAIN_VALUES>
27048 using __FCDualOtherArrayBase = __FCDualArray<TAGP, TAGN, MAXSIZE, CONSTRAIN_VALUES>;
27051 __FCDualOtherArray() =
default;
27053 using __FCDualOtherArrayBase::operator=;
27054 using __FCDualOtherArrayBase::operator std::map<twobyte, twobyte>;
27056 bool Load(CMPER cmper)
27057 {
return __FCDualOtherArrayBase::Load(cmper, 0); }
27059 bool SaveAs(CMPER cmper)
27060 {
return __FCDualOtherArrayBase::SaveAs(cmper, 0); }
27063template<EXTAG TAGP, EXTAG TAGN,
int MAXSIZE,
bool CONSTRAIN_VALUES = true>
27064class __FCDualDetailArray :
public __FCDualArray<TAGP, TAGN, MAXSIZE, CONSTRAIN_VALUES>
27066 using __FCDualDetailArrayBase = __FCDualArray<TAGP, TAGN, MAXSIZE, CONSTRAIN_VALUES>;
27069 __FCDualDetailArray() =
default;
27070 using __FCDualDetailArrayBase::operator=;
27071 using __FCDualDetailArrayBase::operator std::map<twobyte, twobyte>;
27074using __FCCustomKeyModeTonalCenters = __FCDualOtherArray<__ot_KeyToneCenterPositive, __ot_KeyToneCenterNegative, 8>;
27075using __FCCustomKeyModeAcciOrder = __FCDualOtherArray<__ot_KeyAcciOrderPositive, __ot_KeyAcciOrderNegative, 7>;
27076using __FCCustomKeyModeAcciAmounts = __FCDualOtherArray<__ot_KeyAcciAmountPositive, __ot_KeyAcciAmountNegative, 7, false>;
27077using __FCCustomKeyClefOctavePlacement = __FCDualDetailArray<__dt_KeyOctavePlacementPositive, __dt_KeyOctavePlacementNegative, 7, false>;
27079class __FCCustomKeyClefOctavePlacements
27081 std::vector<__FCCustomKeyClefOctavePlacement> _placements;
27084 __FCCustomKeyClefOctavePlacements() =
default;
27086 __FCCustomKeyClefOctavePlacements& operator=(
const std::vector<std::map<twobyte, twobyte>>& values)
27088 _placements.clear();
27089 _placements.resize(values.size());
27090 for (
size_t x = 0; x < _placements.size(); x++)
27091 _placements[x] = values[x];
27095 operator std::vector<std::map<twobyte, twobyte>>()
const
27097 std::vector<std::map<twobyte, twobyte>> retval(_placements.size());
27098 for (
size_t x = 0; x < _placements.size(); x++)
27099 retval[x] = _placements[x];
27103 bool Load(CMPER cmper);
27105 bool SaveAs(CMPER cmper)
27107 for (CMPER x = 0; x < _placements.size(); x++)
27109 if (!_placements[x].SaveAs(cmper, x))
return false;
27114 bool Delete(CMPER cmper)
27116 return __FCCustomKeyClefOctavePlacement().Delete(cmper);
27132 using symbolMap = std::map<twobyte, std::string>;
27138 : _itemno(src._itemno), _list(src._list)
27142 const char*
ClassName()
const override {
return "FCCustomKeyModeSymbolList"; }
27144#ifndef DOXYGEN_SHOULD_IGNORE_THIS
27159 bool Load(CMPER itemno);
27239#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
27241 luabridge::RefCountedPtr<FCString> CreateListString_GC()
const
27300 _FCEDTKeyFormat _format;
27301 _FCEDTKeyAttributes _attributes;
27302 std::vector<eHarmLev> _stepmap;
27303 __FCCustomKeyModeTonalCenters _tonalcenters;
27304 __FCCustomKeyModeAcciOrder _acciorder;
27305 __FCCustomKeyModeAcciAmounts _acciamounts;
27306 __FCCustomKeyClefOctavePlacements _clefplacements;
27308 bool _LoadChildData();
27309 bool _SaveChildData();
27310 bool _DeleteChildData();
27312 bool _LoadStepMap();
27313 bool _SaveStepMap();
27316 bool SaveNew()
override
27318#if PDK_FRAMEWORK_LUAFRIENDLY
27319 throw std::runtime_error(
"SaveNew not implemented for FCCustomKeyModeDef");
27325#ifndef DOXYGEN_SHOULD_IGNORE_THIS
27326 EXTAG
Tag()
const override {
return __ot_KeyFormat; }
27327 int DataSizeLoad()
const override {
return sizeof(_format); }
27328 void*
Allocate()
override {
return (
void*) &_format; }
27337 assert(pSourceKeyModeDef);
27338 _format = pSourceKeyModeDef->_format;
27339 _attributes = pSourceKeyModeDef->_attributes;
27340 _stepmap = pSourceKeyModeDef->_stepmap;
27341 _tonalcenters = pSourceKeyModeDef->_tonalcenters;
27342 _acciorder = pSourceKeyModeDef->_acciorder;
27343 _acciamounts = pSourceKeyModeDef->_acciamounts;
27344 _clefplacements = pSourceKeyModeDef->_clefplacements;
27352 const char*
ClassName()
const override {
return "FCCustomKeyModeDef"; }
27361 memset(&_attributes, 0,
sizeof(_attributes));
27362 memset(&_format, 0,
sizeof(_format));
27365#ifndef DOXYGEN_SHOULD_IGNORE_THIS
27369 if (
Load(0))
return true;
27378 _FCEDTKeyFormat format;
27384 bool Load(CMPER itemno)
override
27387 return _LoadChildData();
27391 bool Save()
override
27393 _format.numDiatonicSteps =
static_cast<twobyte
>(_stepmap.size());
27395 return _SaveChildData();
27401 if (!_DeleteChildData())
return false;
27451 return ::MakeLinearKey(accidentalnumber,
GetItemNo());
27455#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
27457 static int GetKeyID_CFunc(lua_State *L)
27459 return _CFunctionOneOptionalParameter<FCCustomKeyModeDef, eKey, int, &FCCustomKeyModeDef::GetKeyID>(L, 0);
27624#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
27626 luabridge::RefCountedPtr<FCFontInfo> CreateAccidentalFontInfo_GC()
const
27763 if (_tonalcenters.NumPositive() <= 0)
27764 return GetItemNo() == KEYMODE_MINOR ? 5 : 0;
27765 return _tonalcenters[0];
27785 if (value < 0 || value > 6)
27787#ifdef PDK_FRAMEWORK_LUAFRIENDLY
27788 throw std::runtime_error(
"value must be between 0 and 6; got " + std::to_string(value));
27792 if (value == 0 || (value == 5 &&
GetItemNo() == KEYMODE_MINOR))
27795 if (_tonalcenters.NumPositive() == 0 && _tonalcenters.NumNegative() == 0)
27800 SetTonalCenters({{0, value}, {1,0}, {2,0}, {3,0}, {4,0}, {5,0}, {6,0}, {7,0}});
27806 for (
auto& tonalCenter : tonalCenters)
27807 tonalCenter.second = (tonalCenter.second + value) % 7;
27823 return {{-7,0}, {-6,4}, {-5,1}, {-4,5}, {-3,2}, {-2,6}, {-1,3}, {0,0}, {1,4}, {2,1}, {3,5}, {4,2}, {5,6}, {6,3}, {7,0}};
27922 return {{-7,3}, {-6,0}, {-5,4}, {-4,1}, {-3,5}, {-2,2}, {-1,6}, {1,3}, {2,0}, {3,4}, {4,1}, {5,5}, {6,2}, {7,6}};
28006 return {{-7,-1}, {-6,-1}, {-5,-1}, {-4,-1}, {-3,-1}, {-2,-1}, {-1,-1}, {1,1}, {2,1}, {3,1}, {4,1}, {5,1}, {6,1}, {7,1}};
28064 {{-7,0}, {-6,1}, {-5,0}, {-4,1}, {-3,0}, {-2,1}, {-1,0}, {1,1}, {2,1}, {3,1}, {4,1}, {5,0}, {6,1}, {7,0}},
28065 {{-7,-1}, {-6,0}, {-5,-1}, {-4,0}, {-3,-1}, {-2,0}, {-1,-1}, {1,0}, {2,0}, {3,0}, {4,0}, {5,-1}, {6,0}, {7,-1}},
28066 {{-7,-1}, {-6,0}, {-5,-1}, {-4,0}, {-3,-1}, {-2,0}, {-1,-1}, {1,-1}, {2,0}, {3,-1}, {4,0}, {5,-1}, {6,0}, {7,-1}},
28067 {{-7,-2}, {-6,-1}, {-5,-2}, {-4,-1}, {-3,-2}, {-2,-1}, {-1,-2}, {1,-1}, {2,-1}, {3,-1}, {4,-1}, {5,-2}, {6,-1}, {7,-2}},
28068 {{-7,0}, {-6,1}, {-5,0}, {-4,1}, {-3,0}, {-2,1}, {-1,0}, {1,1}, {2,1}, {3,1}, {4,1}, {5,0}, {6,1}, {7,0}},
28069 {{-7,-1}, {-6,0}, {-5,-1}, {-4,0}, {-3,-1}, {-2,0}, {-1,-1}, {1,0}, {2,0}, {3,0}, {4,0}, {5,-1}, {6,0}, {7,-1}},
28070 {{-7,-3}, {-6,-2}, {-5,-3}, {-4,-2}, {-3,-3}, {-2,-2}, {-1,-3}, {1,-2}, {2,-2}, {3,-2}, {4,-2}, {5,-3}, {6,-2}, {7,-3}},
28071 {{-7,-1}, {-6,-1}, {-5,-1}, {-4,-1}, {-3,-1}, {-2,-1}, {-1,-1}, {1,-1}, {2,-1}, {3,-1}, {4,-1}, {5,-1}, {6,-1}, {7,-1}},
28072 {{-7,0}, {-6,1}, {-5,0}, {-4,1}, {-3,0}, {-2,1}, {-1,0}, {1,1}, {2,1}, {3,1}, {4,1}, {5,0}, {6,1}, {7,0}},
28073 {{-7,-1}, {-6,-1}, {-5,-1}, {-4,-1}, {-3,-1}, {-2,-1}, {-1,-1}, {1,-1}, {2,-1}, {3,-1}, {4,-1}, {5,-1}, {6,-1}, {7,-1}},
28074 {{-7,0}, {-6,0}, {-5,0}, {-4,0}, {-3,0}, {-2,0}, {-1,0}, {1,0}, {2,0}, {3,0}, {4,0}, {5,0}, {6,0}, {7,0}},
28075 {{-7,0}, {-6,0}, {-5,0}, {-4,0}, {-3,0}, {-2,0}, {-1,0}, {1,0}, {2,0}, {3,0}, {4,0}, {5,0}, {6,0}, {7,0}},
28076 {{-7,0}, {-6,1}, {-5,0}, {-4,1}, {-3,0}, {-2,1}, {-1,0}, {1,1}, {2,1}, {3,1}, {4,1}, {5,0}, {6,1}, {7,0}},
28077 {{-7,1}, {-6,2}, {-5,1}, {-4,2}, {-3,1}, {-2,2}, {-1,1}, {1,2}, {2,2}, {3,2}, {4,2}, {5,1}, {6,2}, {7,1}},
28078 {{-7,-1}, {-6,0}, {-5,-1}, {-4,0}, {-3,-1}, {-2,0}, {-1,-1}, {1,0}, {2,0}, {3,0}, {4,0}, {5,-1}, {6,0}, {7,-1}},
28079 {{-7,0}, {-6,1}, {-5,0}, {-4,1}, {-3,0}, {-2,1}, {-1,0}, {1,1}, {2,1}, {3,1}, {4,1}, {5,0}, {6,1}, {7,0}},
28080 {{-7,0}, {-6,1}, {-5,0}, {-4,1}, {-3,0}, {-2,1}, {-1,0}, {1,1}, {2,1}, {3,1}, {4,1}, {5,0}, {6,1}, {7,0}},
28081 {{-7,0}, {-6,1}, {-5,0}, {-4,1}, {-3,0}, {-2,1}, {-1,0}, {1,1}, {2,1}, {3,1}, {4,1}, {5,0}, {6,1}, {7,0}}
28108#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
28111 luabridge::RefCountedPtr<FCKeySignature> CreateKeySignature_GC(eHarmAlt alteration)
28115 static int CreateKeySignature_CFunc(lua_State *L)
28117 return _CFunctionOneOptionalParameter<FCCustomKeyModeDef, luabridge::RefCountedPtr<FCKeySignature>, eHarmAlt, &FCCustomKeyModeDef::CreateKeySignature_GC>(L, 0);
Base class for all data-related classes (that handles Finale data).
Definition: ff_base.h:676
virtual void Deallocate()
Definition: ff_base.h:725
EXTAG GetCustomTag() const
Returns the custom Enigma tag, if any.
Definition: ff_base.h:870
virtual __FCBaseData * CreateObject()=0
Creates a new instance of the object.
virtual bool LoadFirst()=0
Loads the very first element in the database, if any.
const PDKFRAMEWORK_CLASSID GetClassID() const override=0
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
EDataID _dataid
The EdataID for the last loaded/saved object.
Definition: ff_base.h:712
bool DataIsLoaded() const
Returns true is any data has been loaded into the object.
Definition: ff_base.h:770
bool LoadDataBlock()
Loads the data. If the object is of dynamic size, the old memory block is freed and a new is allocate...
Definition: finaleframework.cpp:921
void SetCustomTag(EXTAG tag)
Sets the custom Enigma tag, for classes that support multiple Enigma tags.
Definition: ff_base.h:882
void * _datablock
Pointer to the object's data block, the meaning is implementation-specific for each derived subclass.
Definition: ff_base.h:695
virtual EVERSION EnigmaVersion() const
The Enigma version for save/load/create/delete operations.
Definition: ff_base.h:812
virtual int DataSizeLoad() const =0
Returns the data size for the data structure that should be loaded.
virtual int DataSizeSave() const
Returns the data size for the data structure that should be saved or created.
Definition: finaleframework.cpp:916
virtual EXTAG Tag() const =0
The Enigma tag for the derived class.
const EDataID * _GetDataID()
Intended ONLY for the _CloneFrom implementation.
Definition: ff_base.h:848
virtual bool DeleteData()
Deletes the associated data from Finale's database. Be careful when deleting multiple objects.
Definition: finaleframework.cpp:911
virtual bool IsDynamicSize()
Definition: ff_base.h:733
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_base.h:1006
virtual bool LoadNext()
Loads the next element from the database, if any.
Definition: finaleframework.cpp:980
virtual void CloneMemoryFrom(__FCBaseData *pSource)
Definition: finaleframework.cpp:838
void _TagDocumentID()
For internal use only.
Definition: finaleframework.cpp:808
virtual bool Save()
Saves the currently loaded to its current location.
Definition: finaleframework.cpp:951
void DebugDataDump() override
Outputs a memory dump of the data block in the object for debugging purposes.
Definition: ff_base.h:1013
virtual void * Allocate()=0
int _loadedsize
Loaded size of the data block for a loaded object, in bytes. Since the datablock is implementation-sp...
Definition: ff_base.h:708
Base class for the Finale Framework classes.
Definition: ff_base.h:71
static void DebugOutString(const char *pszPrefixText, const char *thestring)
Static method that outputs a line for debugging purposes (C string version). The text appears with th...
Definition: finaleframework.cpp:436
static void DebugOutHex(const char *pszPrefixText, int i)
Static method that outputs a line for debugging purposes. The text appears with the extra digit (in h...
Definition: finaleframework.cpp:404
void Set16BitFlag(FLAG_16 *flag, FLAG_16 flagbits, bool state)
Sets a 16 bit flag.
Definition: finaleframework.cpp:635
PDKFRAMEWORK_CLASSID
Constants for the GetClassID method.
Definition: ff_base.h:84
static void DebugOutInt(const char *pszPrefixText, int i)
Static method that outputs a line for debugging purposes. The text appears with the extra digit (in d...
Definition: finaleframework.cpp:335
static void DebugOut(const char *pszLine)
Static method to output a line of text for debugging purposes.
Definition: finaleframework.cpp:526
bool GetBitFlag(FLAG_32 flag, FLAG_32 flagbits) const
Gets a state from flag bits. Returns true if any bit in the mask is set.
Definition: ff_base.h:485
virtual void DebugDump()
Outputs the class data/information for debugging purposes.
Definition: finaleframework.cpp:609
static void DebugOutBool(const char *pszPrefixText, bool state)
Static method that outputs a line for debugging purposes. The boolean state appears afterwards as eit...
Definition: finaleframework.cpp:451
static void DebugOutBlock(const void *pBuffer, int startoffset, int size)
Static method that outputs a memory block for debugging purposes. Eight bytes per line will appear (a...
Definition: finaleframework.cpp:458
virtual bool SaveAll()
Saves all data in the collection.
Definition: ff_basecollection.h:646
Base class for all collection classes. A collection is a storage that can store multiple objects of s...
Definition: ff_basecollection.h:26
void Add(__FCBase *pNewItem)
Adds an element to the end of the collection.
Definition: finaleframework.cpp:13747
void ClearAll()
Destroys all the objects in the collection and empties the collection.
Definition: ff_basecollection.h:151
int GetCount() const
Returns the number of elements of the collection.
Definition: ff_basecollection.h:102
__FCBase * GetItemAt(int index) const
Returns the object at the index position. Index is 0-based.
Definition: finaleframework.cpp:13788
Base class for "other" data with incis of the __FCInciOther class (where it's common to collect all i...
Definition: ff_basecollection.h:754
virtual bool DeleteDataForItem(CMPER cmper)
Deletes all subrecords (incis) from the Finale database for a specific item (cmper).
Definition: finaleframework.cpp:14088
An internal inci holder for composite time signature bottom elements.
Definition: ff_other.h:435
__FCCompositeTimeSigBottomElement()
The constructor.
Definition: ff_other.h:477
ECompositeTimeLower * _GetThirdRecordPtr()
For internal use only.
Definition: ff_other.h:491
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:495
ECompositeTimeLower * _GetSecondRecordPtr()
For internal use only.
Definition: ff_other.h:488
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:463
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:464
ECompositeTimeLower * _GetFirstRecordPtr()
For internal use only.
Definition: ff_other.h:485
An internal inci holder for composite time signature top elements.
Definition: ff_other.h:364
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:392
__FCCompositeTimeSigTopElement()
The constructor.
Definition: ff_other.h:406
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:421
ECompositeTimeUpper * _GetFirstRecordPtr()
For internal use only.
Definition: ff_other.h:414
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:393
ECompositeTimeUpper * _GetSecondRecordPtr()
For internal use only.
Definition: ff_other.h:417
Base class for "other" (ot_*) data with incis.
Definition: ff_other.h:63
virtual bool SaveNew(CMPER itemno)
Creates a new inci record with data.
Definition: finaleframework.cpp:4838
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:80
int GetItemInci() const
Returns the inci (subrecord) value in the data ID for a loaded record.
Definition: ff_other.h:128
virtual bool Load(CMPER itemno, twobyte inci)
Loads the indicated record within the item number.
Definition: finaleframework.cpp:4801
twobyte CalcLastInci() override
Overridden version of CalcLastInci for __FCInciOther-based classes.
Definition: finaleframework.cpp:4819
int GetItemCmper() const
Returns the cmper (main record) value for a loaded record.
Definition: ff_other.h:116
virtual eMeas GetMeasure() const
Virtual method for returning the measure number.
Definition: ff_other.h:140
virtual TimeEdu32 GetMeasurePos() const
Virtual method for returning the position within the measure.
Definition: ff_other.h:159
virtual eStaff GetStaff() const
Virtual method for returning the staff number.
Definition: ff_other.h:149
bool Reload() override
Overridden version of Reload(), to support complex (mixed) data types.
Definition: finaleframework.cpp:4807
virtual bool HasStaffValue() const
Method that should return true if GetStaff() returns actual values.
Definition: ff_other.h:152
__FCInciOther()
The constructor.
Definition: ff_other.h:79
void _SetCmper(CMPER cmper)
Primarily for internal use.
Definition: ff_other.h:109
Base class for the "Other" (ot_*) Enigma structures that don't use the inci parameter.
Definition: ff_other.h:231
void SetItemNo(CMPER cmper)
Sets the item number. Use with extreme care! This is mostly intended for situations when creating new...
Definition: ff_other.h:332
virtual bool Load(CMPER itemno)
Loads the indicated item.
Definition: finaleframework.cpp:4740
bool LoadFirst() override
Loads the first element of 1-based data.
Definition: ff_other.h:346
virtual bool SaveNew()
Creates the data as completely new item number. The object will now be connected to the new item numb...
Definition: finaleframework.cpp:4765
virtual bool DeepSaveAs(CMPER itemno)
Saves the data under another item number, but also makes a deep copy of the object.
Definition: ff_other.h:292
bool Reload() override
Overridden Reload() method to support complex data types.
Definition: finaleframework.cpp:4746
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:349
__FCNoInciOther()
The constructor.
Definition: ff_other.h:265
virtual CMPER GetItemNo() const
Returns the item number. This typically points to items such as a page number, a measure number,...
Definition: ff_other.h:323
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:262
virtual bool SaveAs(CMPER itemno)
Saves the data under another item number. The object will now be connected to the new item number.
Definition: finaleframework.cpp:4758
bool DeepDeleteData() override
Deletes the data and all related data available in other data structures.
Definition: ff_other.h:303
Base class for all "Other" (ot_*) Enigma structures.
Definition: ff_other.h:26
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:38
bool IsIdenticalRecord(__FCOther *pCompare)
Compares an object to see if both objects point to the same data record.
Definition: ff_other.h:50
void SetCmperAndInci(CMPER cmper, twobyte inci)
Sets both the CMPER and the incident number in the dataID record. Mainly for internal use.
Definition: ff_other.h:30
__FCOther()
The constructor.
Definition: ff_other.h:41
The base class for FCStaff (and its subclass FCCurrentStaffSpec), as well FCStaffStyleDef.
Definition: ff_other.h:7393
static const char FFUUID_KUBING[]
Definition: ff_other.h:8782
static const char FFUUID_GOTTUVADHYAM[]
Definition: ff_other.h:8450
static const char FFUUID_POCKETTRUMPET[]
Definition: ff_other.h:8302
static const char FFUUID_DVOJNICE[]
Definition: ff_other.h:8046
static const char FFUUID_SAUNG[]
Definition: ff_other.h:8546
static const char FFUUID_SHAKUHACHI[]
Definition: ff_other.h:8084
static const char FFUUID_KASHIKLAR[]
Definition: ff_other.h:9230
static const char FFUUID_ODAIKO[]
Definition: ff_other.h:8961
static const char FFUUID_KODAIKO[]
Definition: ff_other.h:8935
static const char FFUUID_TROMBONE[]
Definition: ff_other.h:8248
static const char FFUUID_BOMBARDE[]
Definition: ff_other.h:8158
void SetStemsDownHorizontalOffset(Efix32 value)
Sets the horizontal stem offset for down stems.
Definition: ff_other.h:10556
static const char FFUUID_NADASWARAM[]
Definition: ff_other.h:8182
void SetLineSpacing(Efix32 distance)
Sets the distance between the staff lines, in EFIXs.
Definition: ff_other.h:10758
void SetHalfRestPosition(twobyte position)
Sets the vertical position for the half rests. This setting is located in the "Staff Setup" dialog bo...
Definition: ff_other.h:10350
static const char FFUUID_GUITARRAQUINTAHUAPANGUERA[]
Definition: ff_other.h:8452
static const char FFUUID_KAKKO[]
Definition: ff_other.h:8925
bool GetShowTopRepeatDot() const
Returns if the top repeat dot should be displayed for the staff. This setting is located in the "Staf...
Definition: ff_other.h:9595
static const char FFUUID_DIHU[]
Definition: ff_other.h:7747
static const char FFUUID_RYUTEKI[]
Definition: ff_other.h:8082
static const char FFUUID_SOUSAPHONE[]
Definition: ff_other.h:8262
static const char FFUUID_HANDDRUM[]
Definition: ff_other.h:8913
bool GetAltNotationDisplayOtherLayerNotes() const
Returns true if notes in the non-alternate layers should be displayed.
Definition: ff_other.h:9766
static const char FFUUID_MANDOCELLO[]
Definition: ff_other.h:8500
CMPER GetFullNameID()
Returns the text block ID for the full name. Usually not needed, use CreateFullNameString or CreateTr...
Definition: ff_other.h:10058
static const char FFUUID_SOPRANOXYLOPHONE[]
Definition: ff_other.h:8685
static const char FFUUID_FLEXATONE_PERC[]
Definition: ff_other.h:9192
void Make1LineFullBarlineStaff()
Fills the necessary values in the Staff Setup dialog to make a 1-line staff with full-length barlines...
Definition: ff_other.h:11204
static const char FFUUID_BONES[]
Definition: ff_other.h:9147
static const char FFUUID_CORNETEFLAT[]
Definition: ff_other.h:8270
static const char FFUUID_KESI[]
Definition: ff_other.h:9232
FCString * CreateDisplayAbbreviatedNameString()
Creates an abbreviated staff name for display purposes.
Definition: finaleframework.cpp:9106
static const char FFUUID_KANJIRA[]
Definition: ff_other.h:8927
static const char FFUUID_HUN[]
Definition: ff_other.h:8058
static const char FFUUID_TROUBADORHARP[]
Definition: ff_other.h:8334
static const char FFUUID_JANGGU[]
Definition: ff_other.h:8923
static const char FFUUID_TENORVOICE[]
Definition: ff_other.h:7861
static const char FFUUID_RAUSCHPFEIFE[]
Definition: ff_other.h:8144
static const char FFUUID_BASSTRUMPET[]
Definition: ff_other.h:8294
static const char FFUUID_PAHUHULA[]
Definition: ff_other.h:8967
static const char FFUUID_MANDOBASS[]
Definition: ff_other.h:8498
static const char FFUUID_GUITAR8VB[]
Definition: ff_other.h:8338
static const char FFUUID_PENNYWHISTLE[]
Definition: ff_other.h:7952
twobyte GetCapoPosition() const
For tablature notation: returns the capo position.
Definition: ff_other.h:10094
static const char FFUUID_SLENTHEMSGAMELAN[]
Definition: ff_other.h:8760
static const char FFUUID_VIELLE[]
Definition: ff_other.h:7797
bool GetShowBeams() const
Returns true if beams should be displayed for the staff.
Definition: ff_other.h:9671
void SetStemsDownVerticalOffsetForBeamEnd(Efix32 value)
Sets the vertical stem offset for the beam of end down stems.
Definition: ff_other.h:10580
bool GetShowTextRepeats() const
Returns true if endings and text repeats should be displayed for the staff.
Definition: ff_other.h:9504
static const char FFUUID_ELECTRICPIANO[]
Definition: ff_other.h:7830
static const char FFUUID_TAB_BANJO_D[]
Definition: ff_other.h:8617
void SetAltShowOtherNotes(bool state)
Sets if notes should be displayed on layers other than the altered layer.
Definition: ff_other.h:10828
void SetOtherRestPosition(twobyte position)
Sets the vertical position for the "other" rests. This setting is located in the "Staff Setup" dialog...
Definition: ff_other.h:10360
bool GetShowPartTimeSignatures() const
Returns true if the time signature should be displayed for the staff in parts.
Definition: ff_other.h:9468
static const char FFUUID_KPOKOKPOKO[]
Definition: ff_other.h:9238
static const char FFUUID_GRANDSTAFF[]
Definition: ff_other.h:7700
static const char FFUUID_JARANAHUASTECA[]
Definition: ff_other.h:8468
static const char FFUUID_KONCOVKAALTOFLUTE[]
Definition: ff_other.h:8068
void SetRedisplayOtherLayerAccidentals(bool state)
Sets the "Redisplay accidentals in other layers within measures" state.
Definition: ff_other.h:10919
static const char FFUUID_NIGERIANLOGDRUM[]
Definition: ff_other.h:8959
static const char FFUUID_HARPSICHORD[]
Definition: ff_other.h:7818
static const char FFUUID_BANJOLELE[]
Definition: ff_other.h:8390
static const char FFUUID_VIRGINAL[]
Definition: ff_other.h:7850
Efix32 GetStemsUpVerticalOffsetForNoteheadEnd() const
Returns the vertical stem offset for the notehead end of up stems.
Definition: ff_other.h:9735
static const char FFUUID_UNKNOWN[]
Definition: ff_other.h:7702
static const char FFUUID_TONETANG[]
Definition: ff_other.h:9292
static const char FFUUID_THAIGONG[]
Definition: ff_other.h:9278
static const char FFUUID_QUADTOMS[]
Definition: ff_other.h:8825
void SetAltShowOtherExpressions(bool state)
Sets if expressions should be displayed on layers other than the altered layer.
Definition: ff_other.h:10852
static const char FFUUID_BUGLE[]
Definition: ff_other.h:8268
static const char FFUUID_TAB_BASSGUITAR_6[]
Definition: ff_other.h:8629
static const char FFUUID_GEDUK[]
Definition: ff_other.h:8911
static const char FFUUID_BANDURA[]
Definition: ff_other.h:8388
static const char FFUUID_DILLIKAVAL[]
Definition: ff_other.h:8040
void SetStemsDirection(STAFFSTEMDIRS value)
Sets the stem direction for note entries on the staff. (Staff Stem Settings dialog....
Definition: ff_other.h:10498
static const char FFUUID_LUNTANG[]
Definition: ff_other.h:8794
static const char FFUUID_FLUGELHORN[]
Definition: ff_other.h:8242
void SetAltNotationStyle(ALTERNATE_STAFF value)
Sets the alternate notation style for the staff or staff style.
Definition: ff_other.h:10770
static const char FFUUID_DOLLU[]
Definition: ff_other.h:8889
void SetAltShowOtherArticulations(bool state)
Sets if articulations should be displayed on layers other than the altered layer.
Definition: ff_other.h:10834
void SetAltShowExpression(bool state)
Sets if expressions should be diplayed on the altered layer.
Definition: ff_other.h:10822
static const char FFUUID_BEGENA[]
Definition: ff_other.h:8394
static const char FFUUID_INDIANGONG[]
Definition: ff_other.h:9218
static const char FFUUID_MARIMBA[]
Definition: ff_other.h:8673
bool GetShowPartStaffNames() const
Returns true if part staff names should be displayed for the staff.
Definition: ff_other.h:9657
static const char FFUUID_NGONI[]
Definition: ff_other.h:8518
bool GetAltShowArticulations() const
Returns if articulations should be diplayed on the altered layer.
Definition: ff_other.h:9918
static const char FFUUID_PATSCHEN[]
Definition: ff_other.h:9250
static const char FFUUID_SLIDEWHISTLE_PERCCLEF[]
Definition: ff_other.h:9262
static const char FFUUID_DULCIMER8VB[]
Definition: ff_other.h:8368
static const char FFUUID_DULCIAN[]
Definition: ff_other.h:8164
static const char FFUUID_LYRE[]
Definition: ff_other.h:8496
static const char FFUUID_TAB_GUITAR_7STRING[]
Definition: ff_other.h:8609
static const char FFUUID_FLAMENCOGUITAR[]
Definition: ff_other.h:8443
static const char FFUUID_MELODICA[]
Definition: ff_other.h:7828
static const char FFUUID_MANDOLIN[]
Definition: ff_other.h:8362
static const char FFUUID_YUEQIN[]
Definition: ff_other.h:8589
static const char FFUUID_OCARINA[]
Definition: ff_other.h:7950
static const char FFUUID_APENTEMMA[]
Definition: ff_other.h:8851
bool GetTranspose() const
Returns the transposition status of the staff.
Definition: ff_other.h:11119
void SetAltSlashDots(bool state)
Sets if dots should be added to slashes in compound meters (for altered layers). This setting is only...
Definition: ff_other.h:10866
void SetAltShowOtherSmartShapes(bool state)
Sets if smart shapes should be displayed on layers other than the altered layer.
Definition: ff_other.h:10846
static const char FFUUID_GANDINGANAKAYO[]
Definition: ff_other.h:8778
static const char FFUUID_ZURLA[]
Definition: ff_other.h:8222
static const char FFUUID_TANTAN[]
Definition: ff_other.h:8999
static const char FFUUID_CROMORNE[]
Definition: ff_other.h:8160
static const char FFUUID_ANGKLUNG[]
Definition: ff_other.h:8764
bool GetAllowHiding() const
Returns the "Allow hiding when empty" state. If set, the staff allows "optimization".
Definition: finaleframework.cpp:8740
static const char FFUUID_BORDONUA[]
Definition: ff_other.h:8400
void SetIgnoreKeySig(bool state)
Sets the "Ignore Key Signature" state for the staff.
Definition: ff_other.h:10202
static const char FFUUID_CUICA[]
Definition: ff_other.h:9079
Efix32 GetStemsDownVerticalOffsetForBeamEnd() const
Returns the vertical stem offset for the beam of end down stems.
Definition: ff_other.h:9753
static const char FFUUID_BIFORA[]
Definition: ff_other.h:8156
Efix32 GetStemsUpVerticalOffsetForBeamEnd() const
Returns the vertical stem offset for the beam of end up stems.
Definition: ff_other.h:9747
bool GetShowOnlyFirstMeasureClef() const
For tablature notation: returns if the clef should show only on the first measure.
Definition: ff_other.h:9804
static const char FFUUID_TENORUKULELE[]
Definition: ff_other.h:8376
static const char FFUUID_CASTANETS[]
Definition: ff_other.h:9069
static const char FFUUID_ORGAN2STAFF[]
Definition: ff_other.h:7822
bool GetTransposeChromatic() const
Returns the chromatic transposition status for the staff.
Definition: ff_other.h:9630
static const char FFUUID_PERCACCESSORIES[]
Definition: ff_other.h:9029
static const char FFUUID_CRWTH[]
Definition: ff_other.h:7741
static const char FFUUID_BULLROARER[]
Definition: ff_other.h:9151
void SetVerticalFretOffset(Efix32 value)
For tablature notation: sets the vertical offset for fret numbers.
Definition: ff_other.h:10970
static const char FFUUID_BONGODRUMS[]
Definition: ff_other.h:8839
static const char FFUUID_TAB_DULCIMER_DAA[]
Definition: ff_other.h:8631
static const char FFUUID_PICCOLOOBOE[]
Definition: ff_other.h:7996
static const char FFUUID_TAMBURA[]
Definition: ff_other.h:8556
static const char FFUUID_POWWOWDRUM[]
Definition: ff_other.h:8973
static const char FFUUID_OCTAVEMANDOLIN[]
Definition: ff_other.h:8520
static const char FFUUID_CIMBASSO[]
Definition: ff_other.h:8308
bool GetShowTies() const
Returns true if ties should be displayed for the staff.
Definition: ff_other.h:9759
static const char FFUUID_SYNTHLEAD[]
Definition: ff_other.h:7836
static const char FFUUID_BULGARIANTAMBURA[]
Definition: ff_other.h:8404
bool GetShowTimeSignatures() const
Returns true if the time signature should be displayed for the staff.
Definition: ff_other.h:9435
STAFFNOTATION_STYLE
Styles for the FCStaff::GetNotationStyle() and FCStaff::SetNotationStyle() methods....
Definition: ff_other.h:9308
@ STAFFNOTATION_TABLATURE
Definition: ff_other.h:9316
@ STAFFNOTATION_PERCUSSION
Definition: ff_other.h:9313
@ STAFFNOTATION_NORMAL
Definition: ff_other.h:9310
static const char FFUUID_KETUKGAMELAN[]
Definition: ff_other.h:9121
static const char FFUUID_GUZHENG[]
Definition: ff_other.h:8462
static const char FFUUID_TAB_GUITAR_DROPD[]
Definition: ff_other.h:8605
static const char FFUUID_TROMBAMARINA[]
Definition: ff_other.h:7795
static const char FFUUID_TAB_VIHUELA[]
Definition: ff_other.h:8653
static const char FFUUID_ZITHER[]
Definition: ff_other.h:8380
static const char FFUUID_GONGAGENGGAMELAN[]
Definition: ff_other.h:9113
bool GetAltSlashDots() const
Returns if dots should be added to slashes in compound meters (for altered layers)....
Definition: ff_other.h:9980
static const char FFUUID_BOLON[]
Definition: ff_other.h:8398
bool GetStemsNoteheadEndFixedToStaff() const
Returns the value of "Use Vertical Offset For Notehead End Of Stem: Offset From" radio buttons in the...
Definition: ff_other.h:9711
static const char FFUUID_TAB_GUITAR_DADGAD[]
Definition: ff_other.h:8601
static const char FFUUID_RAINSTICK[]
Definition: ff_other.h:9087
bool GetShowScoreTimeSignatures() const
Returns true if the time signature should be displayed for the staff in the score.
Definition: ff_other.h:9451
static const char FFUUID_MEZZOSOPRANOSAX[]
Definition: ff_other.h:8016
static const char FFUUID_TIMPLE[]
Definition: ff_other.h:8563
static const char FFUUID_UILLEANNPIPES[]
Definition: ff_other.h:7974
static const char FFUUID_CENGCENGGAMELAN[]
Definition: ff_other.h:9111
static const char FFUUID_MAQRUNAH[]
Definition: ff_other.h:8136
static const char FFUUID_SISTRE[]
Definition: ff_other.h:9258
static const char FFUUID_GANGSAGAMELAN[]
Definition: ff_other.h:8738
bool GetBreakRepeatBarlines() const
Returns the "Break repeat barlines between staves" state.
Definition: ff_other.h:9528
static const char FFUUID_STROHVIOLIN[]
Definition: ff_other.h:7793
static const char FFUUID_ALTOGLOCKENSPIEL[]
Definition: ff_other.h:8671
static const char FFUUID_SOPRANORECORDER[]
Definition: ff_other.h:7938
static const char FFUUID_STRINGBASS[]
Definition: ff_other.h:8360
static const char FFUUID_TIMPANI[]
Definition: ff_other.h:8657
static const char FFUUID_DVOJNICEDRONE[]
Definition: ff_other.h:8048
static const char FFUUID_GENDERGAMELAN[]
Definition: ff_other.h:8740
static const char FFUUID_ONDESMARTENOT[]
Definition: ff_other.h:7846
static const char FFUUID_HECKELCLARINA[]
Definition: ff_other.h:8128
static const char FFUUID_BELLS[]
Definition: ff_other.h:8661
static const char FFUUID_MURCHANG[]
Definition: ff_other.h:8798
static const char FFUUID_XIAO[]
Definition: ff_other.h:8104
static const char FFUUID_JAWBONE[]
Definition: ff_other.h:9222
static const char FFUUID_TAB_GUITAR_DOUBLED[]
Definition: ff_other.h:8603
static const char FFUUID_BUFFALODRUM[]
Definition: ff_other.h:8869
static const char FFUUID_VOCALS[]
Definition: ff_other.h:7867
static const char FFUUID_AIRHORN[]
Definition: ff_other.h:9061
static const char FFUUID_JOGIBAJA[]
Definition: ff_other.h:8176
static const char FFUUID_TAB_GUITARNONAME[]
Definition: ff_other.h:8595
bool GetAltShowLyrics() const
Returns if lyrics should be diplayed on the altered layer.
Definition: ff_other.h:9924
static const char FFUUID_EKTARA2[]
Definition: ff_other.h:8448
static const char FFUUID_PI[]
Definition: ff_other.h:8186
static const char FFUUID_BASICINDIANPERCUSSION[]
Definition: ff_other.h:9141
static const char FFUUID_REBEC[]
Definition: ff_other.h:7787
static const char FFUUID_BODHRAN[]
Definition: ff_other.h:8863
static const char FFUUID_GEMSHORN[]
Definition: ff_other.h:8054
static const char FFUUID_SURDO[]
Definition: ff_other.h:8989
static const char FFUUID_POLICEWHISTLE[]
Definition: ff_other.h:9085
static const char FFUUID_IPU[]
Definition: ff_other.h:9220
static const char FFUUID_FLEXATONE_PITCHED[]
Definition: ff_other.h:8704
static const char FFUUID_MARACAS[]
Definition: ff_other.h:9083
static const char FFUUID_GHATAM[]
Definition: ff_other.h:9198
static const char FFUUID_OBOEDACACCIA[]
Definition: ff_other.h:8184
static const char FFUUID_TARDRUM[]
Definition: ff_other.h:9006
static const char FFUUID_TAB_LUTELETTERS[]
Definition: ff_other.h:8641
void SetBreakBarlines(bool state)
Sets the "Break barlines between staves" state.
Definition: ff_other.h:10312
static const char FFUUID_STAMP[]
Definition: ff_other.h:9268
bool GetShowClefs() const
Returns true if clefs should be displayed for the staff.
Definition: ff_other.h:9483
static const char FFUUID_SPLASHCYMBAL[]
Definition: ff_other.h:9053
static const char FFUUID_TIBETANSINGINGBOWLS[]
Definition: ff_other.h:8812
static const char FFUUID_ASHIKO[]
Definition: ff_other.h:8855
static const char FFUUID_SUONA[]
Definition: ff_other.h:8212
static const char FFUUID_CHIMTA[]
Definition: ff_other.h:9161
bool Save() override
Overloaded version of the Save method, that saves any attached objects.
Definition: finaleframework.cpp:8694
static const char FFUUID_SAXHORN[]
Definition: ff_other.h:8304
twobyte GetWholeRestPosition() const
Returns the vertical position for the whole rests. This setting is located in the "Staff Setup" dialo...
Definition: ff_other.h:9574
static const char FFUUID_LANGELEIK[]
Definition: ff_other.h:8494
static const char FFUUID_VIOL[]
Definition: ff_other.h:7799
static const char FFUUID_ZILLS[]
Definition: ff_other.h:9298
static const char FFUUID_DOUBLECLARINET[]
Definition: ff_other.h:8126
static const char FFUUID_FLUTE[]
Definition: ff_other.h:7900
static const char FFUUID_SOPRANOVOICE[]
Definition: ff_other.h:7857
static const char FFUUID_QUINTTOMS[]
Definition: ff_other.h:8827
static const char FFUUID_SOPRANOSAX[]
Definition: ff_other.h:7930
static const char FFUUID_LIRONE[]
Definition: ff_other.h:7777
bool GetShowRepeats() const
Returns true if repeats should be displayed for the staff.
Definition: ff_other.h:9510
static const char FFUUID_PAKHAVAJ[]
Definition: ff_other.h:8969
static const char FFUUID_BYZANTINELYRA[]
Definition: ff_other.h:7737
static const char FFUUID_GUITAR[]
Definition: ff_other.h:8336
static const char FFUUID_CMELODYSAX[]
Definition: ff_other.h:8020
static const char FFUUID_LEIQIN[]
Definition: ff_other.h:7775
static const char FFUUID_VEENA[]
Definition: ff_other.h:8571
static const char FFUUID_CRETANLYRA[]
Definition: ff_other.h:7739
static const char FFUUID_TEMPLEBLOCKS[]
Definition: ff_other.h:9099
Efix32 GetStemsDownHorizontalOffset() const
Returns the horizontal stem offset for down stems.
Definition: ff_other.h:9729
static const char FFUUID_TAMBOURINE[]
Definition: ff_other.h:9039
static const char FFUUID_GYIL[]
Definition: ff_other.h:8780
static const char FFUUID_CHENDA[]
Definition: ff_other.h:8871
bool IsPercussion()
Returns true if the staff is a percussion staff.
Definition: ff_other.h:11090
void SetIndependentFontInfo(const FCFontInfo &font)
Sets the FCFontInfo for the alternate notehead font. You must all set SetIndependentFont to true.
Definition: ff_other.h:11294
static const char FFUUID_CLARINETTEDAMOUR[]
Definition: ff_other.h:8120
static const char FFUUID_GUITARRON[]
Definition: ff_other.h:8454
bool GetAltShowSmartShapes() const
Returns if smart shapes should be diplayed n the altered layer.
Definition: ff_other.h:9930
static const char FFUUID_TINWHISTLEBFLAT[]
Definition: ff_other.h:7960
void SetShowTextRepeats(bool value)
Sets if endings and text repeats should be displayed for the staff.
Definition: ff_other.h:10294
bool GetIgnoreKeySig() const
Returns true if "Ignore Key Signature" is set for the staff.
Definition: ff_other.h:9396
static const char FFUUID_TAEPYEONGSO[]
Definition: ff_other.h:8216
static const char FFUUID_DIPLICA[]
Definition: ff_other.h:8124
static const char FFUUID_HAEGEUM[]
Definition: ff_other.h:7759
static const char FFUUID_TAMBORITA[]
Definition: ff_other.h:8995
static const char FFUUID_AGOGOBLOCK[]
Definition: ff_other.h:9131
static const char FFUUID_TUBULARBELLS[]
Definition: ff_other.h:8679
static const char FFUUID_HOSHO[]
Definition: ff_other.h:9212
static const char FFUUID_TAR_PLUCKED[]
Definition: ff_other.h:8559
static const char FFUUID_BASSETHORN[]
Definition: ff_other.h:8006
static const char FFUUID_BASSDRUM[]
Definition: ff_other.h:8819
static const char FFUUID_BASSMETALLOPHONE[]
Definition: ff_other.h:8726
__FCStaffBase::ALTERNATE_STAFF GetAltNotationStyle()
Returns the alternate notation style for the staff.
Definition: ff_other.h:9901
static const char FFUUID_SANZA[]
Definition: ff_other.h:8804
static const char FFUUID_DULCIMER[]
Definition: ff_other.h:8364
static const char FFUUID_DOIRA[]
Definition: ff_other.h:9183
static const char FFUUID_AGUNG[]
Definition: ff_other.h:9133
void Make0LineFullBarlineStaff()
Fills the necessary values in the Staff Setup dialog to make a staff without staff lines with full-le...
Definition: ff_other.h:11248
static const char FFUUID_CAJON[]
Definition: ff_other.h:9067
void SetWholeRestPosition(twobyte position)
Sets the vertical position for the whole rests. This setting is located in the "Staff Setup" dialog b...
Definition: ff_other.h:10370
static const char FFUUID_KNOTWEEDFLUTE[]
Definition: ff_other.h:8066
static const char FFUUID_NAAL[]
Definition: ff_other.h:8949
static const char FFUUID_BALAPHON[]
Definition: ff_other.h:8770
static const char FFUUID_REEDCONTRABASS[]
Definition: ff_other.h:8194
static const char FFUUID_TAB_LUTEITALIAN[]
Definition: ff_other.h:8639
static const char FFUUID_CONTRABASSFLUTE[]
Definition: ff_other.h:7982
static const char FFUUID_MUSICALBOW[]
Definition: ff_other.h:8516
static const char FFUUID_HELICON[]
Definition: ff_other.h:8314
bool InstrumentMatchesUUID(const char *pszUUID)
Returns true if the UUID string matches the instrument UUID for the staff.
Definition: ff_other.h:11422
static const char FFUUID_DHOL[]
Definition: ff_other.h:8885
void SetDoubleWholeRestPosition(twobyte position)
Sets the vertical position for the double whole rests. This setting is located in the "Staff Setup" d...
Definition: ff_other.h:10380
static const char FFUUID_HICHIRIKI[]
Definition: ff_other.h:8172
static const char FFUUID_BAROQUETRUMPET[]
Definition: ff_other.h:8292
static const char FFUUID_UCHIWADAIKO[]
Definition: ff_other.h:9018
static const char FFUUID_KUTIYAPI[]
Definition: ff_other.h:8492
static const char FFUUID_SAMPHO[]
Definition: ff_other.h:8983
static const char FFUUID_CHACHABELLS[]
Definition: ff_other.h:9155
static const char FFUUID_KUDUM[]
Definition: ff_other.h:8937
static const char FFUUID_SLIDETRUMPET[]
Definition: ff_other.h:8306
static const char FFUUID_AGOGOBELLS[]
Definition: ff_other.h:9059
static const char FFUUID_OKEDODAIKO[]
Definition: ff_other.h:8965
static const char FFUUID_SOPILA[]
Definition: ff_other.h:8206
static const char FFUUID_UDAKU[]
Definition: ff_other.h:9020
bool GetFretLetters() const
For tablature notation: returns if fret letters should be used.
Definition: ff_other.h:9813
static const char FFUUID_CHABARA[]
Definition: ff_other.h:9157
static const char FFUUID_CYMBALS[]
Definition: ff_other.h:9043
static const char FFUUID_ALTOXYLOPHONE[]
Definition: ff_other.h:8687
static const char FFUUID_MODERNTAROGATO[]
Definition: ff_other.h:8148
static const char FFUUID_KAMANCHA[]
Definition: ff_other.h:7767
bool GetRedisplayOtherLayerAccidentals() const
Returns the "Redisplay accidentals in other layers within measures" state.
Definition: ff_other.h:10018
twobyte GetTransposeAlteration() const
Returns the transposition key alteration.
Definition: finaleframework.cpp:8752
static const char FFUUID_BELL_LYRE[]
Definition: ff_other.h:8693
static const char FFUUID_KENDANGGAMELAN[]
Definition: ff_other.h:8929
static const char FFUUID_GUBAN[]
Definition: ff_other.h:9204
static const char FFUUID_DRUMSET[]
Definition: ff_other.h:8821
STAFFSTEMDIRS
Options for the directions in which the staff displays note stems.
Definition: ff_other.h:9324
@ STAFFSTEMDIR_ALWAYS_UP
Definition: ff_other.h:9329
@ STAFFSTEMDIR_ALWAYS_DOWN
Definition: ff_other.h:9332
@ STAFFSTEMDIR_DEFAULT
Definition: ff_other.h:9326
static const char FFUUID_CHROMANOTESINSTRUMENTS[]
Definition: ff_other.h:8697
static const char FFUUID_HNE[]
Definition: ff_other.h:8174
static const char FFUUID_BASSXYLOPHONE[]
Definition: ff_other.h:8689
static const char FFUUID_SRALAI[]
Definition: ff_other.h:8210
static const char FFUUID_TAB_BANJO_DOUBLEC[]
Definition: ff_other.h:8619
static const char FFUUID_SAKARA[]
Definition: ff_other.h:8981
static const char FFUUID_DANTAMTHAPLUC[]
Definition: ff_other.h:8424
void SetIndependentKeySig(bool state)
Sets the state of independent key sigs for the staff.
Definition: ff_other.h:10691
static const char FFUUID_KANTILGAMELAN[]
Definition: ff_other.h:8744
void SetShowRests(bool value)
Sets if rests should be displayed for the staff.
Definition: ff_other.h:10472
static const char FFUUID_ARPEGGIONE[]
Definition: ff_other.h:7733
static const char FFUUID_KULINTANGATINIOK[]
Definition: ff_other.h:8788
static const char FFUUID_HYOUSHIGI[]
Definition: ff_other.h:9214
static const char FFUUID_DONDO[]
Definition: ff_other.h:8891
static const char FFUUID_BANDONEON[]
Definition: ff_other.h:7968
static const char FFUUID_DARABUKA[]
Definition: ff_other.h:8881
static const char FFUUID_BALAFON[]
Definition: ff_other.h:8768
static const char FFUUID_DIZI[]
Definition: ff_other.h:8038
static const char FFUUID_SHIMEDAIKO[]
Definition: ff_other.h:8987
static const char FFUUID_ALTOMETALLOPHONE[]
Definition: ff_other.h:8724
static const char FFUUID_KENONGGAMELAN[]
Definition: ff_other.h:9119
static const char FFUUID_ERXIAN[]
Definition: ff_other.h:7751
static const char FFUUID_CLAVES[]
Definition: ff_other.h:9075
static const char FFUUID_INGOMA[]
Definition: ff_other.h:8919
static const char FFUUID_DABAKAN[]
Definition: ff_other.h:8875
static const char FFUUID_CONCHSHELL[]
Definition: ff_other.h:8322
static const char FFUUID_HORNEFLAT[]
Definition: ff_other.h:8272
static const char FFUUID_MELLOPHONE[]
Definition: ff_other.h:8244
static const char FFUUID_JARANAMOSQUITO[]
Definition: ff_other.h:8472
static const char FFUUID_DOUBLEBELLEUPHONIUM[]
Definition: ff_other.h:8310
static const char FFUUID_PUNGISNAKECHARMER[]
Definition: ff_other.h:8190
static const char FFUUID_TAB_TENORBANJO[]
Definition: ff_other.h:8613
void SetFretLetters(bool state)
For tablature notation: sets if sets letters should be used.
Definition: ff_other.h:10639
twobyte GetStemReversalPosition() const
Returns the stem reversal position offset for the staff. This setting is located in the "Staff Setup"...
Definition: ff_other.h:9588
static const char FFUUID_EWEDRUMKPANLOGO1LARGE[]
Definition: ff_other.h:8901
bool SaveFullNameString(FCString *pString)
Saves the full string. A full name text block ID must exist for the staff, otherwise this method will...
Definition: finaleframework.cpp:9025
static const char FFUUID_SYNTHPAD[]
Definition: ff_other.h:7834
static const char FFUUID_PICCOLOCLARINET[]
Definition: ff_other.h:8010
static const char FFUUID_LIKEMBE[]
Definition: ff_other.h:8792
static const char FFUUID_SETAR[]
Definition: ff_other.h:8552
static const char FFUUID_TROMPETACHINA[]
Definition: ff_other.h:8220
static const char FFUUID_GLOCKENSPIEL[]
Definition: ff_other.h:8667
bool GetShowNoteColors() const
Returns if the staff should display note colors.
Definition: ff_other.h:9547
static const char FFUUID_SLENDROPANERUSGAMELAN[]
Definition: ff_other.h:8758
static const char FFUUID_TRUMPETBFLAT[]
Definition: ff_other.h:8234
void SetTransposeInterval(twobyte value)
Sets the transposition interval.
Definition: finaleframework.cpp:8927
bool GetStemsUseVerticalOffsetForNoteheadEnd() const
Returns the value of "Use Vertical Offset For Notehead End Of Stem" checkbox in the Staff Stem Settin...
Definition: ff_other.h:9700
static const char FFUUID_VIOLASECTION[]
Definition: ff_other.h:7717
static const char FFUUID_MORINKHUUR[]
Definition: ff_other.h:7779
static const char FFUUID_TENORDRUM[]
Definition: ff_other.h:8823
static const char FFUUID_TARKA[]
Definition: ff_other.h:8096
static const char FFUUID_FISCORN[]
Definition: ff_other.h:8298
static const char FFUUID_RIDECYMBAL[]
Definition: ff_other.h:9051
static const char FFUUID_MANJEERA[]
Definition: ff_other.h:9246
static const char FFUUID_CHANCHIKI[]
Definition: ff_other.h:9159
twobyte GetTransposeInterval() const
Returns the transposition interval.
Definition: finaleframework.cpp:8908
static const char FFUUID_VIHUELAMEXICO[]
Definition: ff_other.h:8575
CMPER GetAbbreviatedNameID()
Returns the text block ID for the abbreviated name. Usually not needed, use CreateAbbreviatedNameStri...
Definition: ff_other.h:10047
static const char FFUUID_CLARINETA[]
Definition: ff_other.h:7912
static const char FFUUID_MALLETS[]
Definition: ff_other.h:8659
static const char FFUUID_HIRADAIKO[]
Definition: ff_other.h:8915
static const char FFUUID_CELLO[]
Definition: ff_other.h:7711
static const char FFUUID_GHUNGROO[]
Definition: ff_other.h:9200
static const char FFUUID_DAIBYOSI[]
Definition: ff_other.h:8877
static const char FFUUID_TIMBALEBELL[]
Definition: ff_other.h:9284
static const char FFUUID_BARITONESAX[]
Definition: ff_other.h:7936
static const char FFUUID_AGUNGATAMLANG[]
Definition: ff_other.h:9135
static const char FFUUID_FINGERCYMBALS[]
Definition: ff_other.h:9045
static const char FFUUID_PALENDAG[]
Definition: ff_other.h:8078
static const char FFUUID_FUJARA[]
Definition: ff_other.h:8052
twobyte GetTopRepeatDotPosition() const
Returns the top repeat dot position for the staff. This setting is located in the "Staff Setup" dialo...
Definition: ff_other.h:9615
void SetIndependentTimeSig(bool state)
Sets the independent time sigs state for the staff.
Definition: ff_other.h:10208
static const char FFUUID_TRIANGLE[]
Definition: ff_other.h:9041
static const char FFUUID_TRUMPETD[]
Definition: ff_other.h:8238
static const char FFUUID_XAPHOON[]
Definition: ff_other.h:8024
static const char FFUUID_QUENA[]
Definition: ff_other.h:8080
void SetShowRepeats(bool value)
Sets if repeats should be displayed for the staff.
Definition: ff_other.h:10300
void SetShowBeams(bool value)
Returns true if beams should be displayed for the staff.
Definition: ff_other.h:10492
static const char FFUUID_CLAP[]
Definition: ff_other.h:9071
static const char FFUUID_CHUDAIKO[]
Definition: ff_other.h:8873
static const char FFUUID_SURNAY[]
Definition: ff_other.h:8214
static const char FFUUID_CLASSICALGUITAR[]
Definition: ff_other.h:8342
static const char FFUUID_BOUZOUKI[]
Definition: ff_other.h:8402
bool GetShowTuplets() const
For tablature notation: returns if tuplets should show or not.
Definition: ff_other.h:9795
bool GetShowMeasureNumbers() const
Returns true if measure numbers should be displayed for the staff.
Definition: ff_other.h:9415
STAFF_HIDEMODES GetHideMode() const
Returns how the staff should be hidden.
Definition: finaleframework.cpp:8953
static const char FFUUID_EWEDRUMATOKE[]
Definition: ff_other.h:9185
static const char FFUUID_MOODSWINGER[]
Definition: ff_other.h:8514
void SetBottomBarlineOffset(Evpu16 distance)
Sets the bottom barline offset, in EVPUs. This parameter controls how far the barlines extends downwa...
Definition: ff_other.h:10993
static const char FFUUID_PENNYWHISTLED[]
Definition: ff_other.h:7954
static const char FFUUID_VICHITRAVEENA[]
Definition: ff_other.h:8573
ALTERNATE_STAFF
Alternate staff notation styles for FCStaff::GetAltNotationStyle() and FCStaff::SetAltNotationStyle()...
Definition: ff_other.h:9341
@ ALTSTAFF_RHYTHMIC
Definition: ff_other.h:9350
@ ALTSTAFF_BLANKNOTATIONRESTS
Definition: ff_other.h:9359
@ ALTSTAFF_SLASHBEATS
Definition: ff_other.h:9347
@ ALTSTAFF_NORMAL
Definition: ff_other.h:9344
@ ALTSTAFF_BLANKNOTATION
Definition: ff_other.h:9362
@ ALTSTAFF_TWOBARREPEAT
Definition: ff_other.h:9356
@ ALTSTAFF_ONEBARREPEAT
Definition: ff_other.h:9353
static const char FFUUID_SARONBARUNGGAMELAN[]
Definition: ff_other.h:8752
static const char FFUUID_SOPRANINORECORDER[]
Definition: ff_other.h:7940
void SetStemsDownVerticalOffsetForNoteheadEnd(Efix32 value)
Sets the vertical stem offset for the notehead end of down stems.
Definition: ff_other.h:10568
static const char FFUUID_UKULELE[]
Definition: ff_other.h:8374
static const char FFUUID_BO[]
Definition: ff_other.h:9145
bool GetShowNoteShapes() const
Returns if the staff should display note colors.
Definition: ff_other.h:9553
static const char FFUUID_DOUBLEBASSSECTION[]
Definition: ff_other.h:7723
static const char FFUUID_BIANQING[]
Definition: ff_other.h:8772
static const char FFUUID_TAMTAM[]
Definition: ff_other.h:9055
void SetShowOnlyFirstMeasureClef(bool state)
For tablature notation: sets if the clef should show only on the first measure.
Definition: ff_other.h:10630
static const char FFUUID_WHIP[]
Definition: ff_other.h:9105
static const char FFUUID_ALPHORN[]
Definition: ff_other.h:8280
static const char FFUUID_AEOLIANHARP[]
Definition: ff_other.h:9127
static const char FFUUID_DOUBLEBASS[]
Definition: ff_other.h:7713
static const char FFUUID_HORNF_WWQUINTET[]
Definition: ff_other.h:7970
static const char FFUUID_TRUMPETC[]
Definition: ff_other.h:8236
static const char FFUUID_CELLOSECTION[]
Definition: ff_other.h:7719
static const char FFUUID_BOUGARABOU[]
Definition: ff_other.h:8867
static const char FFUUID_PANCLAPPERS[]
Definition: ff_other.h:9248
static const char FFUUID_TAB_BANJO_C[]
Definition: ff_other.h:8615
static const char FFUUID_REBAB[]
Definition: ff_other.h:7785
static const char FFUUID_KALIMBA[]
Definition: ff_other.h:8720
static const char FFUUID_SANXIAN[]
Definition: ff_other.h:8542
static const char FFUUID_CONTRABASSCLARINET[]
Definition: ff_other.h:7922
static const char FFUUID_DAMROO[]
Definition: ff_other.h:8879
static const char FFUUID_CORNETTO[]
Definition: ff_other.h:8296
static const char FFUUID_CROTALES[]
Definition: ff_other.h:8665
static const char FFUUID_BAGPIPES[]
Definition: ff_other.h:7972
static const char FFUUID_VIOLOTTA[]
Definition: ff_other.h:7807
static const char FFUUID_HANDBELLS_BCLEF[]
Definition: ff_other.h:8714
static const char FFUUID_TENORBANJO[]
Definition: ff_other.h:8350
static const char FFUUID_DJEMBE[]
Definition: ff_other.h:8837
static const char FFUUID_VIOLONCELLOPICCOLO[]
Definition: ff_other.h:7805
void SetTransposeChromatic(bool state)
Sets the chromatic transposition status for the staff.
Definition: ff_other.h:10444
static const char FFUUID_WASHTUBBASS[]
Definition: ff_other.h:8579
static const char FFUUID_CONTRABASSSAX[]
Definition: ff_other.h:8028
bool SaveAbbreviatedNameString(FCString *pString)
Saves the abbreviated string. A abbreviated name text block ID must exist for the staff,...
Definition: finaleframework.cpp:9033
static const char FFUUID_IGIHUMURIZO[]
Definition: ff_other.h:8917
bool GetShowRests() const
Returns true if rests should be displayed for the staff.
Definition: ff_other.h:9651
static const char FFUUID_TAMA[]
Definition: ff_other.h:8993
static const char FFUUID_TEBYOSHI[]
Definition: ff_other.h:9272
static const char FFUUID_EWEDRUMKAGAN[]
Definition: ff_other.h:8899
bool GetStemsUseVerticalOffsetForBeamEnd() const
Returns the value of "Use Vertical Offset For Beam End Of Stem (Offset From Staff)" checkbox in the S...
Definition: ff_other.h:9717
bool GetShowChords() const
Returns true if chords should be displayed for the staff.
Definition: ff_other.h:9490
static const char FFUUID_TIMBALES[]
Definition: ff_other.h:8847
static const char FFUUID_STEELGUITAR[]
Definition: ff_other.h:8346
static const char FFUUID_TENOROVERTONEFLUTE[]
Definition: ff_other.h:8098
static const char FFUUID_DESCANTRECORDER[]
Definition: ff_other.h:7948
static const char FFUUID_SPOONS[]
Definition: ff_other.h:9097
static const char FFUUID_ACOUSTICBASS[]
Definition: ff_other.h:8352
static const char FFUUID_NAGARA[]
Definition: ff_other.h:8953
static const char FFUUID_BASSBAROTONEVOICE[]
Definition: ff_other.h:7879
static const char FFUUID_CUATRO[]
Definition: ff_other.h:8418
static const char FFUUID_DUFF[]
Definition: ff_other.h:8895
bool GetBreakBarlines() const
Returns the "Break barlines between staves" state.
Definition: ff_other.h:9522
static const char FFUUID_PELOGPANERUSGAMELAN[]
Definition: ff_other.h:8746
static const char FFUUID_SHEPHERDSPIPE[]
Definition: ff_other.h:8086
static const char FFUUID_HARPGUITAR[]
Definition: ff_other.h:8464
static const char FFUUID_TASHA[]
Definition: ff_other.h:9008
static const char FFUUID_ALBOGUE[]
Definition: ff_other.h:8108
static const char FFUUID_MADAL[]
Definition: ff_other.h:8941
Evpu16 GetTopBarlineOffset() const
Returns the top barline offset, in EVPUs. This parameter controls how far the barlines extends upward...
Definition: ff_other.h:10145
void SetAltShowOtherLyrics(bool state)
Sets if lyrics should be displayed on layers other than the altered layer.
Definition: ff_other.h:10840
static const char FFUUID_ALTOHORN[]
Definition: ff_other.h:8282
bool GetShowFretboards() const
Returns true if fretboards should be displayed for the staff.
Definition: ff_other.h:9832
static const char FFUUID_AHOKO[]
Definition: ff_other.h:9137
void SetInstrumentUUID(const char *pszUUID)
Sets a predefined UUID for the staff.
Definition: ff_other.h:11025
static const char FFUUID_UDU[]
Definition: ff_other.h:9296
void SetShowStaffLines(bool value)
Sets if staff lines should be displayed for the staff.
Definition: finaleframework.cpp:8801
static const char FFUUID_CHIMES[]
Definition: ff_other.h:8663
static const char FFUUID_PICCOLO[]
Definition: ff_other.h:7898
static const char FFUUID_CHALUMEAU[]
Definition: ff_other.h:8118
static const char FFUUID_ALGAITA[]
Definition: ff_other.h:8154
static const char FFUUID_ALTOCRUMHORN[]
Definition: ff_other.h:8112
static const char FFUUID_MANDORE[]
Definition: ff_other.h:8506
static const char FFUUID_BOMBO[]
Definition: ff_other.h:8865
static const char FFUUID_BATA[]
Definition: ff_other.h:8859
static const char FFUUID_CRYSTALGLASSES[]
Definition: ff_other.h:8701
int CalcTopStaffLinePosition(bool forledgerlines=false) const
Calculates the staff position of the top staff line. For standard 5-lines staves, this value is 0.
Definition: finaleframework.cpp:8981
bool GetIndependentTimeSig() const
Returns true if independent time signatures is set for the staff.
Definition: ff_other.h:9402
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:7693
static const char FFUUID_SNAP[]
Definition: ff_other.h:9266
static const char FFUUID_CONCERTINA[]
Definition: ff_other.h:7966
static const char FFUUID_TINGSHA[]
Definition: ff_other.h:9288
static const char FFUUID_JARANAJAROCHO[]
Definition: ff_other.h:8470
static const char FFUUID_DIDDLEYBOW[]
Definition: ff_other.h:8430
static const char FFUUID_PUEBLODRUM[]
Definition: ff_other.h:8975
static const char FFUUID_GONG[]
Definition: ff_other.h:9057
static const char FFUUID_HANDCYMBAL[]
Definition: ff_other.h:9206
static const char FFUUID_KHIM[]
Definition: ff_other.h:8484
static const char FFUUID_DUTAR[]
Definition: ff_other.h:8436
FCString * CreateTrimmedAbbreviatedNameString()
Creates a string object of the abbreviated staff name without any font information.
Definition: finaleframework.cpp:9146
twobyte GetTransposeClefIndex() const
Returns the clef state in the transposition dialog. This value is valid only of GetTransposeUseClef r...
Definition: ff_other.h:9989
static const char FFUUID_CONTRAALTOFLUTE[]
Definition: ff_other.h:7978
static const char FFUUID_HORNPIPE[]
Definition: ff_other.h:8008
static const char FFUUID_WINDMACHINE[]
Definition: ff_other.h:9107
static const char FFUUID_BASSFLUTE[]
Definition: ff_other.h:7980
static const char FFUUID_VIOLIN[]
Definition: ff_other.h:7707
static const char FFUUID_SOPRILLO[]
Definition: ff_other.h:8018
static const char FFUUID_AULOCHROME[]
Definition: ff_other.h:8022
static const char FFUUID_TUBAX[]
Definition: ff_other.h:8032
static const char FFUUID_FIDDLE[]
Definition: ff_other.h:7753
static const char FFUUID_SHEKERE[]
Definition: ff_other.h:9256
static const char FFUUID_OPHICLEIDE[]
Definition: ff_other.h:8316
static const char FFUUID_SANGBAN[]
Definition: ff_other.h:8985
static const char FFUUID_FIFE[]
Definition: ff_other.h:7990
static const char FFUUID_ALBOKA[]
Definition: ff_other.h:8110
static const char FFUUID_TICTOCBLOCK[]
Definition: ff_other.h:9282
static const char FFUUID_CONTRABASSOON[]
Definition: ff_other.h:7926
void SetAltShowArticulations(bool state)
Sets if articulations should be diplayed on the alternate layer.
Definition: ff_other.h:10804
static const char FFUUID_JAWHARP[]
Definition: ff_other.h:8718
static const char FFUUID_DAHU[]
Definition: ff_other.h:7743
static const char FFUUID_GUITJO[]
Definition: ff_other.h:8456
static const char FFUUID_BASSDRUMS_5LINE[]
Definition: ff_other.h:8835
static const char FFUUID_BERIMBAU[]
Definition: ff_other.h:9143
static const char FFUUID_PIRI[]
Definition: ff_other.h:8188
static const char FFUUID_TOMBAK[]
Definition: ff_other.h:9012
static const char FFUUID_DOUBLECONTRABASSFLUTE[]
Definition: ff_other.h:7984
static const char FFUUID_HARP[]
Definition: ff_other.h:8332
void SetFlatBeams(bool state)
Sets the "Flat beams" state.
Definition: ff_other.h:10615
static const char FFUUID_EWEDRUMKPANLOGO3COMBO[]
Definition: ff_other.h:8905
static const char FFUUID_WHAMOLA[]
Definition: ff_other.h:8581
void SetShowStems(bool value)
Sets if stems should be displayed for the staff.
Definition: ff_other.h:10484
static const char FFUUID_AJAENG[]
Definition: ff_other.h:7731
static const char FFUUID_KOMUZ[]
Definition: ff_other.h:8488
static const char FFUUID_JARANATERCERA[]
Definition: ff_other.h:8476
static const char FFUUID_LAUNEDDAS[]
Definition: ff_other.h:8134
static const char FFUUID_PENYACAHGAMELAN[]
Definition: ff_other.h:8750
static const char FFUUID_SOPRANINOSAX[]
Definition: ff_other.h:8014
static const char FFUUID_NAQARA[]
Definition: ff_other.h:8955
static const char FFUUID_GUAN[]
Definition: ff_other.h:8168
static const char FFUUID_TENORTROMBONE[]
Definition: ff_other.h:8276
void SetShowAugmentationDots(bool value)
Sets if augmentation dots should be displayed for the staff.
Definition: ff_other.h:10325
static const char FFUUID_BASSETCLARINET[]
Definition: ff_other.h:8004
static const char FFUUID_BELLTREE[]
Definition: ff_other.h:9035
static const char FFUUID_VIOLONCELLOSECTION[]
Definition: ff_other.h:7721
static const char FFUUID_BIWA[]
Definition: ff_other.h:8396
static const char FFUUID_NATIVELOGDRUM[]
Definition: ff_other.h:8957
void SetLineCount(twobyte value)
Sets the number of staff lines. Please note that it's usually more efficient to call the 'Make' metho...
Definition: finaleframework.cpp:8834
void SetShowBarlines(bool value)
Sets if barlines should be displayed for the staff.
Definition: ff_other.h:10287
static const char FFUUID_SALLANEH[]
Definition: ff_other.h:8536
static const char FFUUID_MRIDANGAM[]
Definition: ff_other.h:8947
static const char FFUUID_NOSEFLUTE[]
Definition: ff_other.h:8076
static const char FFUUID_RATTLECOG[]
Definition: ff_other.h:9252
static const char FFUUID_GAOHU[]
Definition: ff_other.h:7755
Efix32 GetLineSpacing() const
Returns the distance between the staff lines, in EFIXes.
Definition: ff_other.h:9891
static const char FFUUID_TAB_SITAR_KHAN[]
Definition: ff_other.h:8649
static const char FFUUID_MOROCCODRUM[]
Definition: ff_other.h:8945
static const char FFUUID_XYLOPHONE[]
Definition: ff_other.h:8683
static const char FFUUID_TAB_BANJO_GMODAL[]
Definition: ff_other.h:8621
static const char FFUUID_VENU[]
Definition: ff_other.h:8102
void SetAltShowLyrics(bool state)
Sets if lyrics should be diplayed on the altered layer.
Definition: ff_other.h:10810
static const char FFUUID_KAGUL[]
Definition: ff_other.h:9226
static const char FFUUID_TAB_GAMBA[]
Definition: ff_other.h:8637
static const char FFUUID_TAB_UKULELE[]
Definition: ff_other.h:8651
static const char FFUUID_THAVIL[]
Definition: ff_other.h:9010
void SetNotationStyle(STAFFNOTATION_STYLE value)
Sets the notation style for the staff.
Definition: ff_other.h:10661
static const char FFUUID_HORNF[]
Definition: ff_other.h:8246
static const char FFUUID_KEMPULGAMELAN[]
Definition: ff_other.h:9115
static const char FFUUID_CHING[]
Definition: ff_other.h:9171
static const char FFUUID_BAGLAMA[]
Definition: ff_other.h:8384
static const char FFUUID_PICCOLOHECKELPHONE[]
Definition: ff_other.h:7998
static const char FFUUID_DOBRO[]
Definition: ff_other.h:8432
static const char FFUUID_KENBAU[]
Definition: ff_other.h:8178
static const char FFUUID_DANTRANH[]
Definition: ff_other.h:8426
static const char FFUUID_ZURNA[]
Definition: ff_other.h:8224
static const char FFUUID_TRYCHEL[]
Definition: ff_other.h:9294
static const char FFUUID_HECKELPHONE[]
Definition: ff_other.h:8000
static const char FFUUID_TAB_BASSGUITAR_5[]
Definition: ff_other.h:8627
void Make1LineShortBarlineStaff()
Fills the necessary values in the Staff Setup dialog to make a 1-line staff with short-length barline...
Definition: ff_other.h:11226
static const char FFUUID_YANGQIN[]
Definition: ff_other.h:8585
static const char FFUUID_SLIDEWHISTLE[]
Definition: ff_other.h:8730
static const char FFUUID_SUBCONTRABASSSAX[]
Definition: ff_other.h:8030
static const char FFUUID_PENNYWHISTLEG[]
Definition: ff_other.h:7956
static const char FFUUID_CHIMETREE[]
Definition: ff_other.h:9033
static const char FFUUID_VIOLINOPICCOLO[]
Definition: ff_other.h:7803
static const char FFUUID_SNARELINE[]
Definition: ff_other.h:8833
void SetShowTies(bool state)
Sets if ties should be displayed for the staff.
Definition: ff_other.h:10586
static const char FFUUID_WOODBLOCKS[]
Definition: ff_other.h:9109
static const char FFUUID_VIOLADAGAMBA[]
Definition: ff_other.h:7801
void SetNoKeySigShowAccidentals(bool state)
Sets the "Hide key signature & show all accidentals" state, available in the Finale 2014 Score Manage...
Definition: ff_other.h:10932
static const char FFUUID_FLAGEOLET[]
Definition: ff_other.h:8050
static const char FFUUID_DAFF[]
Definition: ff_other.h:9175
static const char FFUUID_GOME[]
Definition: ff_other.h:9202
bool SaveNewAbbreviatedNameString(FCString *pString)
Saves the abbreviated string as a new staff name block. The staff object must be saved afterwards,...
Definition: finaleframework.cpp:9051
static const char FFUUID_MAROVANY[]
Definition: ff_other.h:8510
static const char FFUUID_TAB_DULCIMER_DAD[]
Definition: ff_other.h:8635
void SetShowBottomRepeatDot(bool state)
Sets if the bottom repeat dot should be displayed for the staff. This setting is located in the "Staf...
Definition: ff_other.h:10411
static const char FFUUID_PSALTERY[]
Definition: ff_other.h:8528
static const char FFUUID_BASSHARMONICA[]
Definition: ff_other.h:7964
static const char FFUUID_BARITONEVOICE[]
Definition: ff_other.h:7863
static const char FFUUID_BASSOON[]
Definition: ff_other.h:7924
static const char FFUUID_ALTOFLUTE[]
Definition: ff_other.h:7902
bool GetAltShowOtherLyrics() const
Returns if lyrics should be displayed on layers other than the altered layer.
Definition: ff_other.h:9954
static const char FFUUID_KAYAGUM[]
Definition: ff_other.h:8482
static const char FFUUID_CHINESEPERCUSSIONENSEMBLE[]
Definition: ff_other.h:9169
static const char FFUUID_OCTOBASS[]
Definition: ff_other.h:7783
static const char FFUUID_MUSICALSAW[]
Definition: ff_other.h:8728
static const char FFUUID_DIPLE[]
Definition: ff_other.h:8042
bool GetAltShowOtherNotes() const
Returns if notes should be displayed on layers other than the altered layer.
Definition: ff_other.h:9942
static const char FFUUID_KOBZA[]
Definition: ff_other.h:8486
static const char FFUUID_SHINOBUE[]
Definition: ff_other.h:8088
static const char FFUUID_ALTOCLARINET[]
Definition: ff_other.h:7916
static const char FFUUID_HECKELPHONECLARINET[]
Definition: ff_other.h:8130
static const char FFUUID_CLAPPER[]
Definition: ff_other.h:9073
FCFontInfo * CreateIndependentFontInfo() const
Creates a FCFontInfo object for the alternate notehead font. GetIndependentFont must be true for this...
Definition: ff_other.h:11272
static const char FFUUID_TAB_GUITAR[]
Definition: ff_other.h:8593
twobyte GetLowestFret() const
For tablature notation, returns the default lowest fret number.
Definition: ff_other.h:10103
static const char FFUUID_HARMONICA[]
Definition: ff_other.h:7962
static const char FFUUID_CHITARRABATTENTE[]
Definition: ff_other.h:8410
static const char FFUUID_SOPRANOGLOCKENSPIEL[]
Definition: ff_other.h:8669
static const char FFUUID_CLARINETBFLAT[]
Definition: ff_other.h:7910
void MakeStandard5LineStaff()
Fills the necessary values in the Staff Setup dialog to make a standard 5-line staff.
Definition: ff_other.h:11182
static const char FFUUID_KUHLOHORN[]
Definition: ff_other.h:8300
static const char FFUUID_DIDGERIDOO[]
Definition: ff_other.h:8284
static const char FFUUID_TOERE[]
Definition: ff_other.h:9290
static const char FFUUID_YAZHENG[]
Definition: ff_other.h:8587
static const char FFUUID_BARYTON[]
Definition: ff_other.h:7735
static const char FFUUID_VALIHA[]
Definition: ff_other.h:8569
static const char FFUUID_EWEDRUMGANGOKUI[]
Definition: ff_other.h:9189
static const char FFUUID_BIANZHONG[]
Definition: ff_other.h:8774
static const char FFUUID_WINDCHIMES[]
Definition: ff_other.h:9031
void SetAltNotationLayer(int value)
Sets the 1-based layer that is used for the alternate notation.
Definition: ff_other.h:10789
static const char FFUUID_ATABAQUE[]
Definition: ff_other.h:8857
static const char FFUUID_TAB_GUITAR_G[]
Definition: ff_other.h:8607
static const char FFUUID_MANDORA[]
Definition: ff_other.h:8504
static const char FFUUID_REQUINTOGUITAR[]
Definition: ff_other.h:8530
bool IsTablature()
Returns true if the staff is a tablature staff.
Definition: ff_other.h:11100
static const char FFUUID_SAXONETTE[]
Definition: ff_other.h:8012
static const char FFUUID_PIPA[]
Definition: ff_other.h:8524
FCString * CreateDisplayFullNameString()
Creates a staff name for display purposes.
Definition: finaleframework.cpp:9075
static const char FFUUID_LAMELLAPHONE[]
Definition: ff_other.h:8790
static const char FFUUID_HYPERBASSFLUTE[]
Definition: ff_other.h:7986
static const char FFUUID_ROTOTOMS[]
Definition: ff_other.h:8829
static const char FFUUID_ZARB[]
Definition: ff_other.h:9022
static const char FFUUID_TUMPONG[]
Definition: ff_other.h:8100
static const char FFUUID_TAB_MANDOLIN[]
Definition: ff_other.h:8643
static const char FFUUID_TUBA[]
Definition: ff_other.h:8258
static const char FFUUID_BABENDIL[]
Definition: ff_other.h:9139
static const char FFUUID_KAVAL[]
Definition: ff_other.h:8062
static const char FFUUID_ACOUSTICGUITAR[]
Definition: ff_other.h:8340
bool GetShowStaffLines() const
Returns true if staff lines should be displayed for the staff.
Definition: finaleframework.cpp:8789
static const char FFUUID_TIBETANBELLS[]
Definition: ff_other.h:8810
static const char FFUUID_EKTARA1[]
Definition: ff_other.h:8441
static const char FFUUID_PIBGORN[]
Definition: ff_other.h:8142
void SetShowMeasureNumbers(bool value)
Sets if measure numbers should be displayed for the staff.
Definition: ff_other.h:10214
static const char FFUUID_SHAWM[]
Definition: ff_other.h:8202
static const char FFUUID_FRETLESSBASS[]
Definition: ff_other.h:8358
static const char FFUUID_SERPENT[]
Definition: ff_other.h:8318
void SetTransposeSimplifyKey(bool state)
Sets the state of the "Simplify Key Sig" in the transposition dialog box.
Definition: ff_other.h:10603
void SetAltNotationDisplayOtherLayerNotes(bool state)
Sets if the non-alternate layers should be displayed or not.
Definition: ff_other.h:10592
static const char FFUUID_ARGHUL[]
Definition: ff_other.h:8114
bool GetIndependentFont() const
Returns if a independent notehead font should be used for the staff.
Definition: ff_other.h:9541
bool GetAltShowOtherSmartShapes() const
Returns if smart shapes should be displayed on layers other than the altered layer.
Definition: ff_other.h:9960
static const char FFUUID_KOKYU[]
Definition: ff_other.h:7769
static const char FFUUID_VIHUELASPAIN[]
Definition: ff_other.h:8577
static const char FFUUID_THEORBO[]
Definition: ff_other.h:8561
static const char FFUUID_VUVUZELA[]
Definition: ff_other.h:8328
static const char FFUUID_DUMBEK[]
Definition: ff_other.h:8897
static const char FFUUID_TALKINGDRUM[]
Definition: ff_other.h:8991
static const char FFUUID_KABOSY[]
Definition: ff_other.h:8478
void SetShowTopRepeatDot(bool state)
Sets if the top repeat dot should be displayed for the staff. This setting is located in the "Staff S...
Definition: ff_other.h:10401
static const char FFUUID_LAVASTONES[]
Definition: ff_other.h:9242
void SetStemsUpHorizontalOffset(Efix32 value)
Sets the horizontal stem offset for up stems.
Definition: ff_other.h:10550
static const char FFUUID_MIZMAR[]
Definition: ff_other.h:8180
static const char FFUUID_GANDINGAN[]
Definition: ff_other.h:9194
static const char FFUUID_VIBRAPHONE[]
Definition: ff_other.h:8681
static const char FFUUID_CHINESEGONGS[]
Definition: ff_other.h:9167
bool GetShowScoreStaffNames() const
Returns true if score staff names should be displayed for the staff.
Definition: ff_other.h:9516
void SetShowFretboards(bool value)
Sets if fretboards should be displayed for the staff.
Definition: ff_other.h:10459
bool GetAltRhythmStemsUp() const
Returns if stems should be freezes up in rhythmic notation (for altered layers). This setting is only...
Definition: ff_other.h:9973
static const char FFUUID_BANJO[]
Definition: ff_other.h:8348
static const char FFUUID_TALKBOX[]
Definition: ff_other.h:7891
static const char FFUUID_KALAAU[]
Definition: ff_other.h:9228
static const char FFUUID_KEMPYANGGAMELAN[]
Definition: ff_other.h:9117
static const char FFUUID_SARRUSOPHONE[]
Definition: ff_other.h:8200
static const char FFUUID_SOPRANOMETALLOPHONE[]
Definition: ff_other.h:8722
void SetTransposeClefIndex(twobyte clefindex)
Sets the clef state in the transposition dialog. This value is valid only of GetTransposeUseClef retu...
Definition: ff_other.h:10892
static const char FFUUID_CITTERN[]
Definition: ff_other.h:8416
static const char FFUUID_DOUNDOUNBA[]
Definition: ff_other.h:8893
static const char FFUUID_HATHELI[]
Definition: ff_other.h:9210
static const char FFUUID_OBOE[]
Definition: ff_other.h:7904
static const char FFUUID_COUNTERTENORVOICE[]
Definition: ff_other.h:7877
static const char FFUUID_KHAENMOUTHORGAN[]
Definition: ff_other.h:8226
static const char FFUUID_DEF[]
Definition: ff_other.h:9181
const char * GetInstrumentUUID() const
Returns the assigned instrument UUID for the staff.
Definition: ff_other.h:10161
static const char FFUUID_JUG[]
Definition: ff_other.h:7994
static const char FFUUID_TABLAS[]
Definition: ff_other.h:8845
void SetAltRhythmStemsUp(bool state)
Sets if stems should be freezes up in rhythmic notation (for altered layers). This setting is only us...
Definition: ff_other.h:10859
static const char FFUUID_BARITONEBC[]
Definition: ff_other.h:8254
static const char FFUUID_ORGAN[]
Definition: ff_other.h:7820
static const char FFUUID_RUAN[]
Definition: ff_other.h:8532
static const char FFUUID_MANDOLA[]
Definition: ff_other.h:8502
void SetShowScoreStaffNames(bool value)
Sets if score staff names should be displayed for the staff.
Definition: ff_other.h:10306
static const char FFUUID_HOCCHIKU[]
Definition: ff_other.h:8056
static const char FFUUID_PICCOLOTRUMPETA[]
Definition: ff_other.h:8266
static const char FFUUID_OUD[]
Definition: ff_other.h:8522
static const char FFUUID_LOWIRISHWHISTLE[]
Definition: ff_other.h:7958
static const char FFUUID_RATTLE[]
Definition: ff_other.h:9091
void SetLowestFret(twobyte value)
For tablature notation, set the default lowest fret number.
Definition: ff_other.h:10943
void SetShowChords(bool value)
Sets if chords should be displayed for the staff.
Definition: ff_other.h:10280
static const char FFUUID_GUIRO[]
Definition: ff_other.h:9081
static const char FFUUID_BOOMWHACKERS[]
Definition: ff_other.h:8695
static const char FFUUID_CHINESECYMBALS[]
Definition: ff_other.h:9165
void SetShowClefs(bool value)
Sets if clefs should be displayed for the staff.
Definition: ff_other.h:10273
void SetShowLyrics(bool value)
Sets if lyrics should be displayed for the staff.
Definition: ff_other.h:10466
static const char FFUUID_BASSRECORDER[]
Definition: ff_other.h:7946
static const char FFUUID_MARIMBASINGLESTAFF[]
Definition: ff_other.h:8677
static const char FFUUID_TAB_DULCIMER_DAAUNISON[]
Definition: ff_other.h:8633
twobyte GetAltNotationLayer() const
Returns the 1-based layer that is used for the alternate notation.
Definition: ff_other.h:9910
static const char FFUUID_TEPONAXTLI[]
Definition: ff_other.h:9276
twobyte GetHalfRestPosition() const
Returns the vertical position for the half rests. This setting is located in the "Staff Setup" dialog...
Definition: ff_other.h:9560
twobyte GetBottomRepeatDotPosition() const
Returns the bottom repeat dot position for the staff. This setting is located in the "Staff Setup" di...
Definition: ff_other.h:9622
static const char FFUUID_ALMGLOCKEN[]
Definition: ff_other.h:8762
static const char FFUUID_BASSVOICE[]
Definition: ff_other.h:7865
static const char FFUUID_ERHU[]
Definition: ff_other.h:7749
static const char FFUUID_GEOMUNGO[]
Definition: ff_other.h:8445
static const char FFUUID_HURDYGURDY[]
Definition: ff_other.h:7763
static const char FFUUID_DUDUK[]
Definition: ff_other.h:8162
static const char FFUUID_AUTOHARP[]
Definition: ff_other.h:8370
static const char FFUUID_SHOFAR[]
Definition: ff_other.h:8326
static const char FFUUID_VIENNAHORN[]
Definition: ff_other.h:8288
static const char FFUUID_EUPHONIUM[]
Definition: ff_other.h:8252
bool HasInstrumentAssigned()
Returns true if there is an instrument assigned to the staff.
Definition: ff_other.h:11465
void SetFretInstrumentDefID(CMPER newid)
Sets the ID for the tablature instrument (for tablature notation).
Definition: ff_other.h:10982
static const char FFUUID_NOHKAN[]
Definition: ff_other.h:8074
bool GetIndependentKeySig() const
Returns true if independent key sigs is set for the staff.
Definition: ff_other.h:9409
static const char FFUUID_XYLORIMBA[]
Definition: ff_other.h:8691
bool GetTransposeUseClef() const
Returns the "Set to clef" state in the transposition dialog.
Definition: ff_other.h:9638
void SetTopRepeatDotPosition(twobyte position)
Sets the top repeat dot position for the staff. This setting is located in the "Staff Setup" dialog b...
Definition: ff_other.h:10421
static const char FFUUID_DAWURO[]
Definition: ff_other.h:9179
static const char FFUUID_JINGLEBELLS[]
Definition: ff_other.h:9037
static const char FFUUID_ZHALEIKA[]
Definition: ff_other.h:8152
static const char FFUUID_CONTRALTOCLARINET[]
Definition: ff_other.h:7918
bool GetFlatBeams() const
Returns the "Flat beams" state.
Definition: ff_other.h:9789
static const char FFUUID_DANBAU[]
Definition: ff_other.h:8420
void SetAllowHiding(bool state)
Sets the "Allow hiding when empty" state. If set, the staff allows "optimization".
Definition: finaleframework.cpp:8746
bool GetNoKeySigShowAccidentals() const
Returns the "Hide key signature & show all accidentals" state, available in the Finale 2014 Score Man...
Definition: ff_other.h:10031
static const char FFUUID_TENORRECORDER[]
Definition: ff_other.h:7944
void SetStemsUpVerticalOffsetForBeamEnd(Efix32 value)
Sets the vertical stem offset for the beam of end up stems.
Definition: ff_other.h:10574
static const char FFUUID_BONGOBELLS[]
Definition: ff_other.h:9149
static const char FFUUID_TAB_SITAR_SHANKAR[]
Definition: ff_other.h:8647
static const char FFUUID_WAGNERTUBA[]
Definition: ff_other.h:8290
static const char FFUUID_TAB_GUITAR_D[]
Definition: ff_other.h:8599
static const char FFUUID_CAXIXI[]
Definition: ff_other.h:9153
static const char FFUUID_VOICENONAME[]
Definition: ff_other.h:7871
static const char FFUUID_INYAHURA[]
Definition: ff_other.h:8921
static const char FFUUID_GLASSMARIMBA[]
Definition: ff_other.h:8708
void SetTransposeAlteration(twobyte value)
Sets the transposition key alteration when transposition is used.
Definition: finaleframework.cpp:8770
static const char FFUUID_KORA[]
Definition: ff_other.h:7771
static const char FFUUID_ELECTRICBASS[]
Definition: ff_other.h:8356
bool GetAltShowOtherArticulations() const
Returns if articulations should be displayed on layers other than the altered layer.
Definition: ff_other.h:9948
static const char FFUUID_STEELDRUMS_BCLEF[]
Definition: ff_other.h:8734
static const char FFUUID_GLASSHARMONICA[]
Definition: ff_other.h:8706
static const char FFUUID_ROTHPHONE[]
Definition: ff_other.h:8198
static const char FFUUID_DANSO[]
Definition: ff_other.h:8036
static const char FFUUID_KKWAENGGWARI[]
Definition: ff_other.h:9236
static const char FFUUID_TELEVI[]
Definition: ff_other.h:9274
static const char FFUUID_TAB_GUITARSTEMS[]
Definition: ff_other.h:8597
static const char FFUUID_ELECTRICGUITAR[]
Definition: ff_other.h:8344
static const char FFUUID_TSYMBALY[]
Definition: ff_other.h:8567
static const char FFUUID_CELESTA[]
Definition: ff_other.h:7824
static const char FFUUID_SYNTHSOUNDTRACK[]
Definition: ff_other.h:7840
static const char FFUUID_CARILLON[]
Definition: ff_other.h:8699
static const char FFUUID_REPINIQUE[]
Definition: ff_other.h:8977
bool GetShowAugmentationDots() const
Returns true if augmentation dots should be displayed for the staff.
Definition: ff_other.h:9535
bool GetTransposeSimplifyKey() const
Returns the state of the "Simplify Key Sig" in the transposition dialog box.
Definition: ff_other.h:9777
static const char FFUUID_DANNGUYET[]
Definition: ff_other.h:8422
static const char FFUUID_BASSTUBA[]
Definition: ff_other.h:8260
static const char FFUUID_BRAKEDRUM[]
Definition: ff_other.h:9063
static const char FFUUID_LARUAN[]
Definition: ff_other.h:7773
static const char FFUUID_GANZA[]
Definition: ff_other.h:9196
static const char FFUUID_JARANASEGUNDA[]
Definition: ff_other.h:8474
static const char FFUUID_RACKETT[]
Definition: ff_other.h:8192
static const char FFUUID_FANGXIANG[]
Definition: ff_other.h:8776
static const char FFUUID_MOHANVEENA[]
Definition: ff_other.h:8512
static const char FFUUID_YODEL[]
Definition: ff_other.h:7885
static const char FFUUID_SAZ[]
Definition: ff_other.h:8548
static const char FFUUID_BARITONETC[]
Definition: ff_other.h:8256
static const char FFUUID_TENORCRUMHORN[]
Definition: ff_other.h:8150
static const char FFUUID_HAMMEREDDULCIMER[]
Definition: ff_other.h:8366
static const char FFUUID_CHOIRAAHS[]
Definition: ff_other.h:7881
Efix32 GetStemsUpHorizontalOffset() const
Returns the horizontal stem offset for up stems.
Definition: ff_other.h:9723
static const char FFUUID_TSUZUMI[]
Definition: ff_other.h:9016
void SetShowNoteShapes(bool state)
Sets if the staff should display note colors.
Definition: ff_other.h:10343
static const char FFUUID_DAFLI[]
Definition: ff_other.h:9177
static const char FFUUID_CHAPMANSTICK[]
Definition: ff_other.h:8406
static const char FFUUID_CONTRABASSSECTION[]
Definition: ff_other.h:7725
static const char FFUUID_GIYINGGAMELAN[]
Definition: ff_other.h:8742
void SetStemsUseVerticalOffsetForNoteheadEnd(bool value)
Sets the value of "Use Vertical Offset For Notehead End Of Stem" checkbox in the Staff Stem Settings ...
Definition: ff_other.h:10527
FCString * CreateFullNameString()
Creates a FCString object of the full staff name (including the Enigma text tags).
Definition: finaleframework.cpp:9060
static const char FFUUID_IRISHBOUZOUKI[]
Definition: ff_other.h:8466
static const char FFUUID_DANGAO[]
Definition: ff_other.h:7745
static const char FFUUID_DULZAINA[]
Definition: ff_other.h:8166
static const char FFUUID_PIANONONAME[]
Definition: ff_other.h:7816
static const char FFUUID_POSTHORN[]
Definition: ff_other.h:8286
bool GetDisplayEmptyRests() const
Returns the "Display Rests in empty measures" state.
Definition: ff_other.h:9783
static const char FFUUID_DANTYBA[]
Definition: ff_other.h:8428
void SetStemsUseVerticalOffsetForBeamEnd(bool value)
Sets the value of "Use Vertical Offset For Beam End Of Stem (Offset From Staff)" checkbox in the Staf...
Definition: ff_other.h:10544
static const char FFUUID_TANGKU[]
Definition: ff_other.h:9001
static const char FFUUID_IBO[]
Definition: ff_other.h:9216
bool GetShowStems() const
Returns true if stems should be displayed for the staff.
Definition: ff_other.h:9663
static const char FFUUID_PANPIPES[]
Definition: ff_other.h:7988
static const char FFUUID_GUITJODOUBLENECK[]
Definition: ff_other.h:8458
twobyte GetDoubleWholeRestPosition() const
Returns the vertical position for the double whole rests. This setting is located in the "Staff Setup...
Definition: ff_other.h:9581
static const char FFUUID_EWEDRUMAXATSE[]
Definition: ff_other.h:9187
static const char FFUUID_HANG[]
Definition: ff_other.h:9208
static const char FFUUID_HULUSI[]
Definition: ff_other.h:8228
FCString * CreateTrimmedFullNameString()
Creates a string object of the full staff name without any font information.
Definition: finaleframework.cpp:9137
Evpu16 GetBottomBarlineOffset() const
Returns the bottom barline offset, in EVPUs. This parameter controls how far the barlines extends dow...
Definition: ff_other.h:10135
static const char FFUUID_SHAKERS[]
Definition: ff_other.h:9095
static const char FFUUID_SHEHNAI[]
Definition: ff_other.h:8204
void SetStemsNoteheadEndFixedToStaff(bool value)
Sets the value of "Use Vertical Offset For Notehead End Of Stem: Offset From" radio buttons in the St...
Definition: ff_other.h:10538
static const char FFUUID_BRASSSECTION[]
Definition: ff_other.h:8264
static const char FFUUID_STRINGENSEMBLE[]
Definition: ff_other.h:7727
void SetShowKeySignatures(bool value)
Sets if the key signature should be displayed for the staff.
Definition: ff_other.h:10221
static const char FFUUID_SHIVAWHISTLE[]
Definition: ff_other.h:8090
STAFFSTEMDIRS GetStemsDirection() const
Returns the stem direction for note entries on the staff. (Staff Stem Settings dialog....
Definition: ff_other.h:9682
void SetBottomRepeatDotPosition(twobyte position)
Sets the bottom repeat dot position for the staff. This setting is located in the "Staff Setup" dialo...
Definition: ff_other.h:10429
static const char FFUUID_TAB_BANJO_G[]
Definition: ff_other.h:8611
static const char FFUUID_ZHONGHU[]
Definition: ff_other.h:7809
static const char FFUUID_RANATTHUMLEK[]
Definition: ff_other.h:8802
static const char FFUUID_HIRTENSCHALMEI[]
Definition: ff_other.h:8132
void SetShowPartStaffNames(bool value)
Sets if part staff names should be displayed for the staff.
Definition: ff_other.h:10478
static const char FFUUID_BANSURI[]
Definition: ff_other.h:8034
static const char FFUUID_RANATEKLEK[]
Definition: ff_other.h:8800
static const char FFUUID_MANGBETU[]
Definition: ff_other.h:8508
static const char FFUUID_CORNET[]
Definition: ff_other.h:8240
static const char FFUUID_ALTORECORDER[]
Definition: ff_other.h:7942
static const char FFUUID_TAPHON[]
Definition: ff_other.h:9003
static const char FFUUID_CRASHCYMBAL[]
Definition: ff_other.h:9047
static const char FFUUID_ENGLISHHORN[]
Definition: ff_other.h:7908
static const char FFUUID_CONGADRUMS[]
Definition: ff_other.h:8841
static const char FFUUID_COWBELL[]
Definition: ff_other.h:9077
void SetDisplayEmptyRests(bool state)
Sets the "Display Rests in empty measures" state.
Definition: ff_other.h:10609
bool IsNormalNotation()
Returns true if the staff is using "normal" music notation (not percussion and not TAB notation).
Definition: ff_other.h:11109
twobyte GetDefaultClef() const
Returns the start/default clef.
Definition: ff_other.h:9995
static const char FFUUID_VIOLINSECTION[]
Definition: ff_other.h:7715
static const char FFUUID_EWEDRUMKPANLOGO2MEDIUM[]
Definition: ff_other.h:8903
static const char FFUUID_TAIKODRUMS[]
Definition: ff_other.h:8806
static const char FFUUID_IGIL[]
Definition: ff_other.h:7765
static const char FFUUID_ACCORDION[]
Definition: ff_other.h:7826
twobyte GetOtherRestPosition() const
Returns the vertical position for the "other" rests. This setting is located in the "Staff Setup" dia...
Definition: ff_other.h:9567
static const char FFUUID_NEY[]
Definition: ff_other.h:8072
static const char FFUUID_KOUDI[]
Definition: ff_other.h:8070
static const char FFUUID_SNAREDRUM[]
Definition: ff_other.h:8817
static const char FFUUID_ALTOSAX[]
Definition: ff_other.h:7932
static const char FFUUID_LUOGONG[]
Definition: ff_other.h:9244
static const char FFUUID_BOTTLEBLOW[]
Definition: ff_other.h:7992
static const char FFUUID_RIQ[]
Definition: ff_other.h:9254
static const char FFUUID_BASSCLARINET[]
Definition: ff_other.h:7920
bool GetShowLyrics() const
Returns true if lyrics should be displayed for the staff.
Definition: ff_other.h:9645
static const char FFUUID_CORNAMUSE[]
Definition: ff_other.h:8122
static const char FFUUID_LOGDRUM[]
Definition: ff_other.h:8843
FCString * CreateAbbreviatedNameString()
Creates a string object of the abbreviated staff name (including the Enigma text tags).
Definition: finaleframework.cpp:9067
static const char FFUUID_THEREMIN[]
Definition: ff_other.h:7848
static const char FFUUID_CLAVINET[]
Definition: ff_other.h:7832
static const char FFUUID_SARONDEMONGGAMELAN[]
Definition: ff_other.h:8754
static const char FFUUID_MIJWIZ[]
Definition: ff_other.h:8138
static const char FFUUID_MEZZOSOPRANOVOICE[]
Definition: ff_other.h:7873
static const char FFUUID_SHAMISEN[]
Definition: ff_other.h:8554
static const char FFUUID_EWEDRUMSOGO[]
Definition: ff_other.h:8907
static const char FFUUID_GUANZI[]
Definition: ff_other.h:8170
static const char FFUUID_SYNTHBRASS[]
Definition: ff_other.h:7838
static const char FFUUID_BASSMARIMBA[]
Definition: ff_other.h:8675
void SetTopBarlineOffset(Evpu16 distance)
Sets the top barline offset, in EVPUs. This parameter controls how far the barlines extends upwards.
Definition: ff_other.h:11004
static const char FFUUID_KULINTANG[]
Definition: ff_other.h:8784
static const char FFUUID_SARONPANERUSGAMELAN[]
Definition: ff_other.h:8756
static const char FFUUID_GAIDAPIPES[]
Definition: ff_other.h:7976
static const char FFUUID_SUBCONTRABASSTUBA[]
Definition: ff_other.h:8320
static const char FFUUID_HIHATCYMBAL[]
Definition: ff_other.h:9049
static const char FFUUID_HANG_TCLEF[]
Definition: ff_other.h:8716
CMPER GetFretInstrumentDefID() const
Returns the ID for the tablature instrument (for tablature notation). Use the FCFretInstrumentDef cla...
Definition: ff_other.h:10125
static const char FFUUID_TINAJA[]
Definition: ff_other.h:9286
bool GetShowBottomRepeatDot() const
Returns if the bottom repeat dot should be displayed for the staff. This setting is located in the "S...
Definition: ff_other.h:9605
static const char FFUUID_VOICE[]
Definition: ff_other.h:7869
static const char FFUUID_SE[]
Definition: ff_other.h:8550
static const char FFUUID_WINDSECTION[]
Definition: ff_other.h:7928
static const char FFUUID_NAGADODAIKO[]
Definition: ff_other.h:8951
static const char FFUUID_MBIRA[]
Definition: ff_other.h:8796
static const char FFUUID_PIANO[]
Definition: ff_other.h:7814
void SetShowTuplets(bool state)
For tablature notation: sets if tuplets should show or not.
Definition: ff_other.h:10621
void SetStemReversalPosition(twobyte position)
Sets the stem reversal position offset for the staff. This setting is located in the "Staff Setup" di...
Definition: ff_other.h:10390
static const char FFUUID_OKAWA[]
Definition: ff_other.h:8963
static const char FFUUID_TAB_BASSGUITAR_4[]
Definition: ff_other.h:8625
static const char FFUUID_CHINATEMPLEBLOCKS[]
Definition: ff_other.h:9163
static const char FFUUID_BONANGGAMELAN[]
Definition: ff_other.h:8736
static const char FFUUID_BASSGUITAR[]
Definition: ff_other.h:8354
static const char FFUUID_VOCALPERCUSSION[]
Definition: ff_other.h:7893
static const char FFUUID_CHIPPLI[]
Definition: ff_other.h:9173
static const char FFUUID_SHENG[]
Definition: ff_other.h:8230
static const char FFUUID_ALTOTROMBONE[]
Definition: ff_other.h:8274
static const char FFUUID_LUTE[]
Definition: ff_other.h:8372
void SetIndependentFont(bool state)
Sets if a independent notehead font should be used for the staff.
Definition: ff_other.h:10331
static const char FFUUID_DOUBLEFLUTE[]
Definition: ff_other.h:8044
static const char FFUUID_KANTELE[]
Definition: ff_other.h:8480
static const char FFUUID_PORTUGUESEGUITAR[]
Definition: ff_other.h:8526
static const char FFUUID_BASSTROMBONE[]
Definition: ff_other.h:8250
static const char FFUUID_IRISHFLUTE[]
Definition: ff_other.h:8060
bool GetBreakTablatureLines() const
For tablature notation: returns if tablature lines should break at fret numbers.
Definition: ff_other.h:9822
static const char FFUUID_KOTO[]
Definition: ff_other.h:8490
static const char FFUUID_CLARINETEFLAT[]
Definition: ff_other.h:7914
bool SaveNewFullNameString(FCString *pString)
Saves the full string as a new staff name block. The staff object must be saved afterwards,...
Definition: finaleframework.cpp:9041
static const char FFUUID_OBOEDAMORE[]
Definition: ff_other.h:7906
bool GetAltShowExpression() const
Returns if expressions should be diplayed on the altered layer.
Definition: ff_other.h:9936
static const char FFUUID_SISTRUM[]
Definition: ff_other.h:9260
static const char FFUUID_CHOAZHOUGUZHENG[]
Definition: ff_other.h:8412
static const char FFUUID_AFOXE[]
Definition: ff_other.h:9129
static const char FFUUID_LAMBEGDRUM[]
Definition: ff_other.h:8939
static const char FFUUID_CONTRABASSTROMBONE[]
Definition: ff_other.h:8278
void SetShowPartTimeSignatures(bool value)
Sets if the time signature should be displayed for the staff in parts. This does nothing on Finale ve...
Definition: ff_other.h:10261
static const char FFUUID_VIBRASLAP[]
Definition: ff_other.h:9101
static const char FFUUID_CLAVICHORD[]
Definition: ff_other.h:7852
static const char FFUUID_GUQIN[]
Definition: ff_other.h:8460
static const char FFUUID_BARBAT[]
Definition: ff_other.h:8392
static const char FFUUID_KRINSLITDRUM[]
Definition: ff_other.h:9240
static const char FFUUID_SLITDRUM[]
Definition: ff_other.h:9264
static const char FFUUID_SARANGI[]
Definition: ff_other.h:7789
static const char FFUUID_SITAR[]
Definition: ff_other.h:8378
static const char FFUUID_BALALAIKA[]
Definition: ff_other.h:8386
static const char FFUUID_NYCKELHARPA[]
Definition: ff_other.h:7781
static const char FFUUID_SANDBLOCK[]
Definition: ff_other.h:9093
static const char FFUUID_KENKENI[]
Definition: ff_other.h:8931
void SetShowScoreTimeSignatures(bool value)
Sets if the time signature should be displayed for the staff in the score.
Definition: ff_other.h:10245
static const char FFUUID_OCTAVIN[]
Definition: ff_other.h:8140
static const char FFUUID_HANDBELLS_TCLEF[]
Definition: ff_other.h:8712
static const char FFUUID_SULING[]
Definition: ff_other.h:8094
twobyte GetLineCount() const
Returns the number of staff lines for the staff.
Definition: finaleframework.cpp:8813
static const char FFUUID_HARDANGERFIDDLE[]
Definition: ff_other.h:7761
static const char FFUUID_MADDALE[]
Definition: ff_other.h:8943
static const char FFUUID_STIRDRUM[]
Definition: ff_other.h:9270
static const char FFUUID_CHARANGO[]
Definition: ff_other.h:8408
static const char FFUUID_BASSSAX[]
Definition: ff_other.h:8026
static const char FFUUID_VIOLADAMORE[]
Definition: ff_other.h:7729
static const char FFUUID_RATCHET[]
Definition: ff_other.h:9089
void SetTransposeUseClef(bool state)
Sets the "Set to clef" state in the transposition dialog.
Definition: ff_other.h:10452
static const char FFUUID_PEMADEGAMELAN[]
Definition: ff_other.h:8748
static const char FFUUID_DOMRA[]
Definition: ff_other.h:8434
static const char FFUUID_CHOIROOHS[]
Definition: ff_other.h:7883
static const char FFUUID_PERCUSSIONGENERAL[]
Definition: ff_other.h:9027
static const char FFUUID_CONTRALTOVOICE[]
Definition: ff_other.h:7875
static const char FFUUID_STEELDRUMS_TCLEF[]
Definition: ff_other.h:8732
static const char FFUUID_ANCIENTTAROGATO[]
Definition: ff_other.h:8218
static const char FFUUID_HORAGAI[]
Definition: ff_other.h:8324
static const char FFUUID_HARMONIUM[]
Definition: ff_other.h:7844
static const char FFUUID_HANDBELLS[]
Definition: ff_other.h:8710
bool GetShowKeySignatures() const
Returns true if the key signature should be displayed for the staff.
Definition: ff_other.h:9422
static const char FFUUID_TIBETANCYMBALS[]
Definition: ff_other.h:9280
static const char FFUUID_FONTOMFROM[]
Definition: ff_other.h:8909
static const char FFUUID_XALAM[]
Definition: ff_other.h:8583
static const char FFUUID_SARANGIDRONE[]
Definition: ff_other.h:7791
bool GetShowBarlines() const
Returns true if barlines should be displayed for the staff.
Definition: ff_other.h:9497
static const char FFUUID_WASHBOARD[]
Definition: ff_other.h:9103
static const char FFUUID_SOUNDFX[]
Definition: ff_other.h:7842
Efix32 GetStemsDownVerticalOffsetForNoteheadEnd() const
Returns the vertical stem offset for the notehead end of down stems.
Definition: ff_other.h:9741
static const char FFUUID_SIPSI[]
Definition: ff_other.h:8146
static const char FFUUID_BEATBOX[]
Definition: ff_other.h:7887
static const char FFUUID_SANSHIN[]
Definition: ff_other.h:8538
static const char FFUUID_KULINTANGAKAYO[]
Definition: ff_other.h:8786
static const char FFUUID_DUXIANQIN[]
Definition: ff_other.h:8438
static const char FFUUID_KHOL[]
Definition: ff_other.h:8933
virtual FCStaffNamePosition * GetFullNamePosition()
Gets the name position object for the full staff name. The object is of the FCStaffNamePosition class...
Definition: finaleframework.cpp:9158
STAFFNOTATION_STYLE GetNotationStyle() const
Returns the notation style for the staff.
Definition: ff_other.h:9843
void SetShowNoteColors(bool state)
Sets if the staff should display note colors.
Definition: ff_other.h:10337
static const char FFUUID_RUDRAVEENA[]
Definition: ff_other.h:8534
virtual FCStaffNamePosition * GetAbbreviatedNamePosition()
Gets the name position object for the abbreviated staff name. The object is of the FCStaffNamePositio...
Definition: finaleframework.cpp:9169
static const char FFUUID_XUN[]
Definition: ff_other.h:8106
static const char FFUUID_KAEKEEKE[]
Definition: ff_other.h:9224
static const char FFUUID_SACKBUT[]
Definition: ff_other.h:8312
static const char FFUUID_BLANKSTAFF[]
Definition: ff_other.h:7698
void SetShowTimeSignatures(bool value)
Sets if the time signature should be displayed for the staff in both score and parts.
Definition: ff_other.h:10231
static const char FFUUID_ARCHLUTE[]
Definition: ff_other.h:8382
Efix32 GetVerticalFretOffset() const
For tablature notation: returns the vertical offset for fret numbers.
Definition: ff_other.h:10115
static const char FFUUID_KHLUI[]
Definition: ff_other.h:8064
static const char FFUUID_VIOLA[]
Definition: ff_other.h:7709
static const char FFUUID_TUMBAK[]
Definition: ff_other.h:9014
static const char FFUUID_KAZOO[]
Definition: ff_other.h:7889
bool GetAltShowOtherExpressions() const
Returns if expressions should be displayed on layers other than the altered layer.
Definition: ff_other.h:9966
void SetHideMode(STAFF_HIDEMODES value)
Sets how the staff should be hidden.
Definition: finaleframework.cpp:8854
static const char FFUUID_TAB_BANJO_PLECTRUM[]
Definition: ff_other.h:8623
int CalcBottomStaffLinePosition(bool forledgerlines=false) const
Calculates the staff position of the bottom staff line. For standard 5-lines staves,...
Definition: finaleframework.cpp:9003
STAFF_HIDEMODES
The different hide modes for FCStaff::GetHideMode() and FCStaff::SetHideMode().
Definition: ff_other.h:9371
@ STAFFHIDE_SCORE
Definition: ff_other.h:9376
@ STAFFHIDE_SCORE_AND_PARTS
Definition: ff_other.h:9379
@ STAFFHIDE_NORMAL
Definition: ff_other.h:9373
@ STAFFHIDE_CUTAWAY
Definition: ff_other.h:9382
static const char FFUUID_RHAITA[]
Definition: ff_other.h:8196
void SetBreakRepeatBarlines(bool state)
Sets the "Break repeat barlines between staves" state.
Definition: ff_other.h:10318
static const char FFUUID_SAROD[]
Definition: ff_other.h:8544
static const char FFUUID_TENORLINE[]
Definition: ff_other.h:8831
static const char FFUUID_REYONGGAMELAN[]
Definition: ff_other.h:9123
static const char FFUUID_ARABIANFRAMEDRUM[]
Definition: ff_other.h:8853
static const char FFUUID_AFRICANLOGDRUM[]
Definition: ff_other.h:8849
static const char FFUUID_SORNA[]
Definition: ff_other.h:8208
void SetAltShowSmartShapes(bool state)
Sets if smart shapes should be diplayed n the altered layer.
Definition: ff_other.h:10816
static const char FFUUID_GEHU[]
Definition: ff_other.h:7757
void SetStemsUpVerticalOffsetForNoteheadEnd(Efix32 value)
Sets the vertical stem offset for the notehead end of up stems.
Definition: ff_other.h:10562
static const char FFUUID_DATANGULIONDRUM[]
Definition: ff_other.h:8883
static const char FFUUID_DHOLAK[]
Definition: ff_other.h:8887
static const char FFUUID_TRES[]
Definition: ff_other.h:8565
static const char FFUUID_ARRAYMBIRA[]
Definition: ff_other.h:8766
static const char FFUUID_SANTOOR[]
Definition: ff_other.h:8540
void MakeNormalNotation()
Transforms a staff to "normal" (not TAB and not percussion).
Definition: ff_other.h:11079
static const char FFUUID_BASSOBOE[]
Definition: ff_other.h:8002
static const char FFUUID_TENORSAX[]
Definition: ff_other.h:7934
static const char FFUUID_ADODO[]
Definition: ff_other.h:9125
static const char FFUUID_SABAR[]
Definition: ff_other.h:8979
void SetBreakTablatureLines(bool state)
For tablature notation: sets if tablature lines should break at fret numbers.
Definition: ff_other.h:10648
static const char FFUUID_KHARTAL[]
Definition: ff_other.h:9234
static const char FFUUID_CABASA[]
Definition: ff_other.h:9065
static const char FFUUID_TAMTE[]
Definition: ff_other.h:8997
void SetCapoPosition(twobyte value)
For tablature notation: sets the capo position.
Definition: ff_other.h:10956
static const char FFUUID_TEMPLEBELLS[]
Definition: ff_other.h:8808
void SetDefaultClef(twobyte clefindex)
Sets the start/default clef.
Definition: ff_other.h:10905
static const char FFUUID_CIMBALOM[]
Definition: ff_other.h:8414
static const char FFUUID_PANDERO[]
Definition: ff_other.h:8971
static const char FFUUID_SHVI[]
Definition: ff_other.h:8092
static const char FFUUID_BAWU[]
Definition: ff_other.h:8116
static const char FFUUID_BENDIR[]
Definition: ff_other.h:8861
static const char FFUUID_ALTOVOICE[]
Definition: ff_other.h:7859
static const char FFUUID_TAB_REQUINTO[]
Definition: ff_other.h:8645
Class for allotment data (in the Document Options).
Definition: ff_other.h:20147
void SetWidth(Evpu16 width)
Sets the allotment reference width (int EVPUs).
Definition: ff_other.h:20218
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:20191
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:20235
FCAllotment()
The constructor.
Definition: ff_other.h:20207
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:20190
Evpu16 GetWidth() const
Returns the allotment reference width (int EVPUs).
Definition: ff_other.h:20228
The class for an articulation definition. On Finale 2012 and above, this class supports the Unicode c...
Definition: ff_other.h:12287
void SetAlwaysPlaceOutsideStaff(bool state)
Sets the state of the "Always place outside staff" setting.
Definition: ff_other.h:13212
void SetMainSymbolFont(const std::string &pszFontName)
Sets the main symbol font.
Definition: finaleframework.cpp:10094
void SetFlippedSymbolChar(eUniChar32 symbol)
Sets the character for the flipped symbol. On Finale 2012 and above, this supports the Unicode range.
Definition: ff_other.h:13111
const EFONTID GetMainSymbolFontID() const
Returns the internal document-specific font ID for the main symbol.
Definition: finaleframework.cpp:9682
std::string GetMainSymbolFont() const
Gets the font name for the main symbol.
Definition: finaleframework.cpp:9661
void SetCenterHorizontally(bool state)
Sets the state of the "Center horizontally" setting.
Definition: ff_other.h:13218
void SetOnStemDistanceFromStemEnd(twobyte value)
Sets the "On-stem distance from stem end/flag/beam" value.
Definition: finaleframework.cpp:9878
void SetAutoPosSide(ARTPOSITIONING_SIDES mode)
Sets the vertical auto positioning setting for the articulation definition.
Definition: finaleframework.cpp:9739
bool GetAvoidStaffLines() const
Returns the state of the "Avoid staff lines" setting.
Definition: ff_other.h:12690
bool GetDurationIsPercent() const
Returns the "Values are percentages" for "Duration" playback change.
Definition: ff_other.h:12646
void SetDurationIsPercent(bool value)
Sets the "Values are percentages" for the "Duration" playback change.
Definition: ff_other.h:13357
void SetVelocityIsPercent(bool value)
Sets the "Values are percentages" for the "Velocity" playback change.
Definition: ff_other.h:13391
bool GetFlippedSymbolIsShape() const
Returns true if the flipped symbol is a shape.
Definition: ff_other.h:12833
void SetInsideSlurs(bool state)
Sets the state of the "Inside slurs" setting.
Definition: ff_other.h:13246
void SetTopDuration(twobyte value)
Sets the Top Note Value for "Duration" change of playback.
Definition: ff_other.h:13337
void SetFlippedHandleVerticalOffset(Evpu16 value)
Sets the vertical offset to handle for the flipped symbol.
Definition: ff_other.h:13316
twobyte GetFlippedSymbolShapeID() const
Returns the shape ID for the flipped symbol.
Definition: ff_other.h:12530
void SetFlippedSymbolShapeID(twobyte shapeID)
Sets the shape ID for the flipped symbol.
Definition: ff_other.h:13098
FCFontInfo * CreateMainSymbolFontInfo() const
Creates a FCFontInfo object based on the main symbol font information.
Definition: finaleframework.cpp:9947
bool GetCenterOnStemWhenStemSide() const
Returns the state of the "Center over/under stem when stem side" setting.
Definition: finaleframework.cpp:9913
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:13394
void SetCenterOnStemWhenStemSide(bool state)
Sets the state of the "Center over/under stem when stem side" setting.
Definition: finaleframework.cpp:9862
void SetTopVelocity(twobyte value)
Sets the Top Note Value for "Velocity" change of playback.
Definition: ff_other.h:13363
bool IsFlippedSymbolFont(const char *pszFontName) const
Returns true if the flipped symbol font matches the font string. The font name check is case sensitiv...
Definition: finaleframework.cpp:9939
Evpu16 GetDefaultVerticalPos() const
Returns the default vertical position for the articulation definition.
Definition: ff_other.h:12769
twobyte GetBottomDuration() const
Returns the Bottom Note Value for "Duration" change of playback.
Definition: ff_other.h:12658
void SetAvoidStaffLines(bool state)
Sets the state of the "Avoid staff lines" setting.
Definition: ff_other.h:13224
bool IsIdenticalTo(const FCArticulationDef &compareWith, bool playbackinfo, bool positioningvalues, bool positioningoptions, bool defaultside) const
Compares the articulation definition to another definition and checks if all settings are identical.
Definition: finaleframework.cpp:10135
void SetStackAutomatically(bool state)
Sets the state of the "Stack automatically" setting.
Definition: finaleframework.cpp:9854
twobyte GetMainSymbolShapeID() const
Returns the shape ID for the main symbol.
Definition: ff_other.h:12513
bool GetCopyMainSymbolHorizontally() const
Returns the state of the "Horizontally/Vertically" setting that's used (when GetCopyMainSymbol is set...
Definition: ff_other.h:12611
FCFontInfo * CreateFlippedSymbolFontInfo() const
Creates a FCFontInfo object based on the flipped symbol font information.
Definition: finaleframework.cpp:9954
bool IsShapeUsed()
Returns true if a shape is used for the articulation definition.
Definition: ff_other.h:12840
twobyte GetTopVelocity() const
Returns the Top Note Value for "Velocity" change of playback.
Definition: ff_other.h:12670
void SetFlippedSymbolSize(twobyte size)
Sets the flipped symbol font size.
Definition: finaleframework.cpp:10063
void SetCopyMainSymbol(bool state)
Sets the state of the "Copy the Main Symbol" setting.
Definition: ff_other.h:13148
bool GetMainSymbolIsShape() const
Returns true if the main symbol is a shape.
Definition: ff_other.h:12824
void SetFlippedSymbolFontID(EFONTID fontid)
Sets the internal document-specific font ID for the flipped symbol.
Definition: finaleframework.cpp:10107
twobyte GetTopDuration() const
Returns the Top Note Value for "Duration" change of playback.
Definition: ff_other.h:12652
void SetPlayback(bool state)
Sets the playback change state bit for the articulation definition.
Definition: ff_other.h:13166
void SetFlippedHandleHorizontalOffset(Evpu16 value)
Sets the horizontal offset to handle for the flipped symbol.
Definition: ff_other.h:13326
eUniChar32 GetAboveSymbolChar() const
Returns the character for the "above" symbol. On Finale 2012 and above, this supports the Unicode ran...
Definition: ff_other.h:12472
void SetStemSideWhenMultipleLayers(bool state)
Sets the state of the "place stem side when multiple layers are present" setting.
Definition: finaleframework.cpp:9870
bool GetInsideSlurs() const
Returns the state of the "Inside slurs" setting.
Definition: ff_other.h:12730
bool GetCopyMainSymbol() const
Returns the state of the "Copy the Main Symbol" setting.
Definition: ff_other.h:12601
bool GetPlayback() const
Gets the playback change state bit for the articulation definition.
Definition: ff_other.h:12619
void SetBottomVelocity(twobyte value)
Sets the Bottom Note Value for "Velocity" change of playback.
Definition: ff_other.h:13373
bool GetBelowUsesMain() const
Return the state of the "When Placed Below a Note, Use the" setting.
Definition: ff_other.h:12594
std::string GetFlippedSymbolFont() const
Gets the font name for the flipped symbol.
Definition: finaleframework.cpp:9700
void SetAttackIsPercent(bool state)
Sets the "Values are percentages" state for the "Attack" playback change.
Definition: ff_other.h:13173
eUniChar32 GetFlippedSymbolChar() const
Returns the character for the flipped symbol. On Finale 2012 and above, this supports the Unicode ran...
Definition: finaleframework.cpp:9625
twobyte GetBottomAttack() const
Returns the Bottom Note Value for "Attack" change of playback.
Definition: ff_other.h:12639
bool IsMainSymbolFont(const char *pszFontName) const
Returns true if the main symbol font matches the font string. The font name check is case sensitive.
Definition: finaleframework.cpp:9931
Evpu16 GetMainHandleVerticalOffset() const
Gets the vertical offset to handle for the main symbol.
Definition: ff_other.h:12795
void SetMainSymbolSize(twobyte size)
Sets the main symbol font size.
Definition: finaleframework.cpp:10047
const EFONTID GetFlippedSymbolFontID() const
Returns the internal document-specific font ID for the flipped symbol.
Definition: finaleframework.cpp:9721
void SetFlippedSymbolIsShape(bool useshape)
Set the flipped symbol to use shape or a font character.
Definition: ff_other.h:13075
void SetBottomAttack(twobyte value)
Sets the Bottom Note Value for "Attack" change of playback.
Definition: ff_other.h:13190
Evpu16 GetFlippedHandleVerticalOffset() const
Gets the vertical offset to handle for the flipped symbol.
Definition: ff_other.h:12809
void SetOnScreenOnly(bool state)
Sets the flag if the articulation definition should be displayed on the screen only.
Definition: ff_other.h:12940
void SetBelowSymbolChar(eUniChar32 symbol)
Sets the character for the "below" symbol. On Finale 2012 and above, this supports the Unicode range.
Definition: ff_other.h:13030
twobyte GetBottomVelocity() const
Returns the Bottom Note Value for "Velocity" change of playback.
Definition: ff_other.h:12676
void SetSlurInteraction(ARTSLUR_INTERACTION mode)
Sets the "Slur Interaction" setting.
Definition: finaleframework.cpp:9824
twobyte GetMainSymbolSize() const
Returns the font size of the main symbol.
Definition: finaleframework.cpp:9637
void SetCopyMainSymbolHorizontally(bool state)
Sets the state of the "Horizontally/Vertically" setting that's used (when GetCopyMainSymbol is set).
Definition: ff_other.h:13158
ARTSLUR_INTERACTION GetSlurInteraction() const
Gets the settings for slur interaction.
Definition: finaleframework.cpp:9892
bool GetOnScreenOnly() const
Returns true if the main symbol should not print.
Definition: ff_other.h:12431
void SetMainHandleVerticalOffset(Evpu16 value)
Sets the vertical offset to handle for the main symbol.
Definition: ff_other.h:13294
void SetDefaultVerticalPos(Evpu16 value)
Sets the default vertical position for the articulation definition.
Definition: ff_other.h:13283
ARTPOSITIONING_SIDES
The auto positioning modes for articulations. Used by FCArticulationDef::GetAutoPosSide() and FCArtic...
Definition: ff_other.h:12369
twobyte GetOnStemDistanceFromStemEnd() const
Returns the "On-stem distance from stem end/flag/beam" value.
Definition: finaleframework.cpp:9815
void SetMainSymbolFontInfo(FCFontInfo *pFontInfo)
Sets the main symbol font for the articulation definition based on a FCFontInfo record.
Definition: finaleframework.cpp:10005
ARTSLUR_INTERACTION
The options for slur interaction used by FCArticulationDef::GetSlurInteraction() and FCArticulationDe...
Definition: ff_other.h:12391
void SetFlippedSymbolFont(const std::string &pszFontName)
Sets the flipped symbol font.
Definition: finaleframework.cpp:10122
bool GetVelocityIsPercent() const
Returns the "Values are percentages" for "Velocity" playback change.
Definition: ff_other.h:12664
ARTPOSITIONING_SIDES GetAutoPosSide() const
Gets the vertical auto positioning setting for the articulation definition.
Definition: finaleframework.cpp:9790
void SetBelowUsesMain(bool state)
Sets the state of the "When Placed Below a Note, Use the" setting.
Definition: ff_other.h:13142
void SetAboveSymbolChar(eUniChar32 symbol)
Sets the character for the "above" symbol. On Finale 2012 and above, this supports the Unicode range.
Definition: ff_other.h:13016
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:12399
Evpu16 GetMainHandleHorizontalOffset() const
Gets the horizontal offset to handle for the main symbol.
Definition: ff_other.h:12802
void GetMainSymbolFontInfo(FCFontInfo *pFontInfo) const
Gets the main symbol font for the articulation definition based on a FCFontInfo record.
Definition: finaleframework.cpp:9961
void SetFlippedSymbolFontInfo(FCFontInfo *pFontInfo)
Sets the flipped symbol font for the articulation definition based on a FCFontInfo record.
Definition: finaleframework.cpp:10026
Evpu16 GetFlippedHandleHorizontalOffset() const
Gets the horizontal offset to handle for the flipped symbol.
Definition: ff_other.h:12815
eUniChar32 GetMainSymbolChar() const
Returns the character for the main symbol. On Finale 2012 and above, this supports the Unicode range.
Definition: finaleframework.cpp:9612
void SetMainHandleHorizontalOffset(Evpu16 value)
Sets the horizontal offset to handle for the main symbol.
Definition: ff_other.h:13305
bool GetAlwaysPlaceOutsideStaff() const
Returns the state of the "Always place outside staff" setting.
Definition: ff_other.h:12697
twobyte GetFlippedSymbolSize() const
Returns the font size of the flipped symbol.
Definition: finaleframework.cpp:9649
void SetAttachToTopNote(bool state)
Sets the state of the "Attach to top note" setting.
Definition: ff_other.h:13252
void SetTopAttack(twobyte value)
Sets the Top Note Value for "Attack" change of playback.
Definition: ff_other.h:13180
void SetBottomDuration(twobyte value)
Sets the Bottom Note Value for "Duration" change of playback.
Definition: ff_other.h:13347
bool GetAttachToTopNote() const
Returns the state of the "Attach to top note" setting.
Definition: ff_other.h:12736
void SetAboveUsesMain(bool state)
Sets the state of the "When Placed Above a Note, Use the" setting.
Definition: ff_other.h:13133
void GetFlippedSymbolFontInfo(FCFontInfo *pFontInfo) const
Gets the flipped symbol font for the articulation definition based on a FCFontInfo record.
Definition: finaleframework.cpp:9983
FCArticulationDef()
The constructor.
Definition: ff_other.h:12417
void SetMainSymbolChar(eUniChar32 symbol)
Sets the character for the main symbol. On Finale 2012 and above, this supports the Unicode range.
Definition: ff_other.h:13045
void SetMainSymbolFontID(EFONTID fontid)
Sets the internal document-specific font ID for the main symbol.
Definition: finaleframework.cpp:10079
void SetMainSymbolShapeID(CMPER shapeID)
Sets the shape ID for the main symbol.
Definition: ff_other.h:13086
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:12398
bool GetAttackIsPercent() const
Returns the "Values are percentages" state for the "Attack" playback change.
Definition: ff_other.h:12626
bool GetAboveUsesMain() const
Return the state of the "When Placed Above a Note, Use the" setting.
Definition: ff_other.h:12585
bool GetStackAutomatically() const
Returns the state of the "Stack automatically" setting.
Definition: finaleframework.cpp:9904
eUniChar32 GetBelowSymbolChar() const
Returns the character for the "below" symbol. On Finale 2012 and above, this supports the Unicode ran...
Definition: ff_other.h:12489
void SetMainSymbolIsShape(bool useshape)
Set the main symbol to use shape or a font character.
Definition: ff_other.h:13065
twobyte GetTopAttack() const
Returns the Top Note Value for "Attack" change of playback.
Definition: ff_other.h:12633
bool GetCenterHorizontally() const
Returns the state of the "Center horizontally" setting.
Definition: ff_other.h:12704
bool GetStemSideWhenMultipleLayers() const
Returns the state of the "place stem side when multiple layers are present" setting.
Definition: finaleframework.cpp:9922
Class for attaching an articulation definition to an entry.
Definition: ff_entrydetails.h:1839
The class for a backward repeat definition.
Definition: ff_other.h:23156
FCTextRepeat::REPSHOWMODES GetShowMode() const
Returns on which staves the backward repeat should be shown.
Definition: ff_other.h:23306
FCSeparatePlacements * CreateSeparatePlacements()
Creates a FCSeparatePlacements collection and loads it with all matching independent positioning reco...
Definition: finaleframework.cpp:11754
FCTextRepeat::REPTARGETTRIGGERS GetTargetTrigger() const
Returns the target trigger for the backwards repeat. This value also affects how the GetTargetMeasure...
Definition: ff_other.h:23396
void SetBottomBracketPosition(Evpu16 position)
Sets the vertical bottom position of the bracket.
Definition: ff_other.h:23433
void SetRightBracketPosition(Evpu16 position)
Sets the horizontal right-side position of the bracket.
Definition: ff_other.h:23442
twobyte GetStaffListID() const
Gets the staff list ID.
Definition: ff_other.h:23290
Evpu16 GetBottomBracketPosition() const
Returns the vertical bottom position of the bracket.
Definition: ff_other.h:23263
Evpu16 GetRightBracketPosition() const
Returns the horizontal right-side position of the bracket.
Definition: ff_other.h:23272
void SetTotalPasses(twobyte passes)
Sets the number of passes for the playback. This is used as value for "Jump on Pass" as well.
Definition: ff_other.h:23377
void SetVisible(bool state)
Sets if the repeat is visible. ("Show" is checked in the context menu.)
Definition: ff_other.h:23367
void SetIndividualPositioning(bool state)
Returns true if the bracket has individual positioning.
Definition: ff_other.h:23358
eMeas GetTargetMeasure() const
Sets the playback destination measure for the backward repeat.
Definition: ff_other.h:23214
void SetLeftBracketPosition(Evpu16 position)
Sets the horizontal left-side position of the bracket.
Definition: ff_other.h:23451
Evpu16 GetTopBracketPosition() const
Returns the vertical top position of the bracket.
Definition: ff_other.h:23254
void SetTargetTrigger(FCTextRepeat::REPTARGETTRIGGERS value)
Set the target trigger for the backward repeat. This method should also be combined with a SetTargetM...
Definition: ff_other.h:23473
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:23186
bool GetVisible() const
Returns true if the repeat is visible. ("Show" is checked in the context menu.)
Definition: ff_other.h:23235
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:23185
void SetResetOnRepeatAction(bool state)
Sets the "Reset on Repeat Action" state.
Definition: ff_other.h:23507
void SetTargetMeasure(eMeas measure)
Sets the playback destination measure for the backward repeat.
Definition: ff_other.h:23349
bool GetResetOnRepeatAction() const
Returns the "Reset on Repeat Action" state.
Definition: ff_other.h:23415
void SetShowMode(FCTextRepeat::REPSHOWMODES mode)
Sets where the backward repeat should be shown.
Definition: ff_other.h:23319
FCBackwardRepeat()
The constructor.
Definition: ff_other.h:23202
FCTextRepeat::REPACTIONS GetAction() const
Returns the action type for the backward repeat. This controls what should happen when the text repea...
Definition: ff_other.h:23525
Evpu16 GetLeftBracketPosition() const
Returns the horizontal left-side position of the bracket.
Definition: ff_other.h:23281
bool GetIndividualPositioning() const
Returns true if the bracket has individual positioning.
Definition: ff_other.h:23223
void SetStaffListID(twobyte stafflistid)
Sets the staff list ID.
Definition: ff_other.h:23460
void SetTopBracketPosition(Evpu16 position)
Sets the vertical position of the bracket.
Definition: ff_other.h:23424
twobyte GetTotalPasses() const
Returns the number of passes for the playback. This is used as value for "Jump on Pass" as well.
Definition: ff_other.h:23245
void SetAction(FCTextRepeat::REPACTIONS mode)
Sets the action type for the backward repeat. This controls what should happen when the backward repe...
Definition: ff_other.h:23553
The class for one single beat chart element.
Definition: ff_other.h:23615
Evpu16 GetMinimumPosition() const
Returns the minimum position for the element.
Definition: ff_other.h:23734
void SetNextHorizontalPosition(Evpu16 value)
Sets the next position in the measure.
Definition: ff_other.h:23877
void SetMinimumPosition(Evpu16 value)
Sets the minimum position for the element.
Definition: ff_other.h:23893
Evpu16 GetReferenceWidth() const
Returns the reference width for the beat chart.
Definition: ff_other.h:23801
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:23659
void SetHorizontalPosition(Evpu16 position)
Sets the position of the beat chart element.
Definition: ff_other.h:23863
bool GetInitElement() const
Returns true if it's the first (init) element in the chart. The init element defines the full beat ch...
Definition: ff_other.h:23812
void SetFullSpan(Evpu16 span)
Sets the full span for the beat chart.
Definition: ff_other.h:23917
Evpu16 GetHorizontalPosition() const
Returns the position in the measure for the element (in EVPUs).
Definition: ff_other.h:23706
Evpu16 GetNextHorizontalPosition() const
Returns the next position in the measure.
Definition: ff_other.h:23719
void SetMeasurePos(TimeEdu32 edupos)
Sets the duration reference position for the element.
Definition: ff_other.h:23839
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:23660
TimeEdu32 GetTotalDuration() const
Returns the total duration for the beat chart.
Definition: ff_other.h:23750
Evpu16 GetMinimumWidth() const
Returns the minimum width for the beat chart.
Definition: ff_other.h:23783
FCBeatChartElement()
The constructor.
Definition: ff_other.h:23677
bool MoveHorizontalPosition(Evpu16 offset, FCBeatChartElements *pBeatChart)
"Moves" the beat chart element by the offset amount.
Definition: finaleframework.cpp:11772
void SetMinimumWidth(Evpu16 width)
Sets the minimum width for the beat chart.
Definition: ff_other.h:23932
TimeEdu32 GetMeasurePos() const override
Return the duration reference position for the element.
Definition: ff_other.h:23697
Evpu16 CalcWidth()
Calculates and returns the width of the beat chart element.
Definition: ff_other.h:23826
void SetReferenceWidth(Evpu16 width)
Sets the reference width for the beat chart.
Definition: ff_other.h:23944
Evpu16 GetFullSpan() const
Returns the full span for the beat chart.
Definition: ff_other.h:23765
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:23967
void SetWidth(Evpu16 width)
Sets the width of the beat chart element.
Definition: ff_other.h:23851
void SetTotalDuration(TimeEdu32 dura)
Sets the total duration for the beat chart. This should be the same duration as the measure.
Definition: ff_other.h:23905
Collection class for FCBeatChartElement class objects (which is a beat chart for a measure).
Definition: ff_othercollection.h:1543
The class for a Finale bookmark.
Definition: ff_other.h:26526
FCBookmark()
The constructor.
Definition: ff_other.h:26593
void SetViewType(BOOKMARKTYPES value)
Sets the view type for the bookmark.
Definition: ff_other.h:26724
ePercent GetViewPercent() const
Get the view percent to which to scale the view. This value is only used if GetUseViewPercent is true...
Definition: ff_other.h:26662
int GetHorizontalPosInst() const
Returns the first scroll locator for the bookmark.
Definition: ff_other.h:26687
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:26814
void SetViewPercent(ePercent value)
Set the view percent to which to scale the view. This value is only used if SetUseViewPercent is true...
Definition: ff_other.h:26738
int GetLocator() const
Returns the locator for the bookmark.
Definition: ff_other.h:26676
bool IsForScrollView() const
Returns true if this bookmark is for Scroll View.
Definition: ff_other.h:26810
void SetLocator(int value)
Sets the locator for the bookmark.
Definition: ff_other.h:26753
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:26552
int GetVerticalPosStaffSet() const
Returns the second scroll locator for the bookmark.
Definition: ff_other.h:26704
bool GetUseHorizontalPosInst() const
Indicates whether to use the value returned by GetHorizontalPosInst.
Definition: ff_other.h:26693
void SetHorizontalPosInst(int value)
Sets the first scroll locator for the bookmark.
Definition: ff_other.h:26764
BOOKMARKTYPES GetViewType() const
Returns the view type for the bookmark.
Definition: ff_other.h:26654
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:26553
bool GetUseVerticalPosStaffSet() const
Indicates whether to use the value returned by GetVerticalPosStaffSet.
Definition: ff_other.h:26715
bool IsForPageView() const
Returns true if this bookmark is for Page View.
Definition: ff_other.h:26801
bool SaveNameString(const FCString *pString)
Saves the name of the bookmark.
Definition: finaleframework.cpp:13397
BOOKMARKTYPES
The bookmark type.
Definition: ff_other.h:26581
@ BOOKMARKTYPE_PAGEVIEW
Definition: ff_other.h:26583
@ BOOKMARKTYPE_SCROLLVIEW
Definition: ff_other.h:26586
void SetUseVerticalPosStaffSet(bool state)
Sets whether to use the value specified by SetVerticalPosStaffSet.
Definition: ff_other.h:26793
void SetUseHorizontalPosInst(bool state)
Sets whether to use the value specified by SetHorizontalPosInst.
Definition: ff_other.h:26770
void SetVerticalPosStaffSet(int value)
Sets the second scroll locator for the bookmark.
Definition: ff_other.h:26781
void SetUseViewPercent(bool state)
Sets if the view will be scaled. The scale value is specified by SetViewPercent.
Definition: ff_other.h:26744
FCString * CreateNameString()
Creates a string with the name of the bookmark. This is the string that appears in Finale's Bookmarks...
Definition: ff_other.h:26611
bool GetUseViewPercent() const
Indicates if the view will be scaled. The scale value is specified by GetViewPercent.
Definition: ff_other.h:26668
Text used for a bookmarks. Please refer to the FCBookmark class.
Definition: ff_text.h:372
Class for a category definition.
Definition: ff_other.h:13416
void SetVerticalEntryOffset(twobyte value)
Sets the vertical "Additional Entry Offset" value in the category definition.
Definition: ff_other.h:14319
bool GetOverrideStaffList() const
Gets the value for if staff lists are used for this category.
Definition: ff_other.h:13802
bool UsesStaffList()
Returns true if the category uses a staff list.
Definition: ff_other.h:14201
bool IsDefaultMiscellaneous()
Returns true if the category is the standard (pre-defined/Finale-created) category "Miscellaneous".
Definition: ff_other.h:14125
bool GetBreakMMRest() const
Gets the "Break Multi-measure rest" option from the category definition. For many categories,...
Definition: ff_other.h:13793
bool UsesTextFont()
Returns true if the category uses the text font settings.
Definition: ff_other.h:14207
FCFontInfo * CreateTextFontInfo()
Creates a FCFontInfo object from the text font.
Definition: ff_other.h:14096
HORIZ_JUSTIFICATION
The horizontal justification settings for the category.
Definition: ff_other.h:13750
@ EXPRJUSTIFY_CENTER
Definition: ff_other.h:13755
@ EXPRJUSTIFY_RIGHT
Definition: ff_other.h:13758
@ EXPRJUSTIFY_LEFT
Definition: ff_other.h:13752
void SetName(FCString *pString)
Sets the name of the category.
Definition: ff_other.h:14227
HORIZ_JUSTIFICATION GetHorizontalJustification() const
Gets the "Horizontal Justification" in the category definition.
Definition: ff_other.h:13952
HORIZ_ALIGNMENT GetHorizontalAlignmentPoint() const
Gets the "Horizontal Alignment Point" in the category definition.
Definition: ff_other.h:13967
bool SaveNewWithType(CATEGORY_DEFAULTIDS type)
Creates a new category definition based on the input type. The new category inherits features of the ...
Definition: finaleframework.cpp:10270
FCString * CreateName()
Creates a string object with the category name.
Definition: ff_other.h:13898
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:13643
bool GetNumberFontInfo(FCFontInfo *pInfo)
Gets the font info for the number font.
Definition: ff_other.h:14017
VERT_ALIGNMENT
The vertical alignment points available to categories and expressions.
Definition: ff_other.h:13662
@ ALIGNVERT_BELOWENTRY
Definition: ff_other.h:13685
@ ALIGNVERT_BELOW_STAFF_BASELINE
Definition: ff_other.h:13673
@ ALIGNVERT_CLICKPOS
Definition: ff_other.h:13664
@ ALIGNVERT_BOTTOMNOTE
Definition: ff_other.h:13679
@ ALIGNVERT_STAFF_REFERENCE_LINE
Definition: ff_other.h:13667
@ ALIGNVERT_ABOVE_STAFF_BASELINE
Definition: ff_other.h:13670
@ ALIGNVERT_BELOW_STAFF_BASELINE_OR_ENTRY
Definition: ff_other.h:13691
@ ALIGNVERT_ABOVEENTRY
Definition: ff_other.h:13682
@ ALIGNVERT_TOPNOTE
Definition: ff_other.h:13676
@ ALIGNVERT_ABOVE_STAFF_BASELINE_OR_ENTRY
Definition: ff_other.h:13688
void SetHorizontalOffset(twobyte value)
Sets the "Additional Horizontal Offset" in the category definition.
Definition: ff_other.h:14357
twobyte GetVerticalEntryOffset() const
Returns the vertical "Additional Entry Offset" in the category definition.
Definition: ff_other.h:13937
bool SetMusicFontInfo(FCFontInfo *pInfo)
Sets the font info for the music font.
Definition: ff_other.h:14049
bool GetUserCreated() const
Returns true if the category was user created.
Definition: ff_other.h:14115
CATEGORY_MODE
Constants used by the FCString::ReplaceCategoryFonts method.
Definition: ff_other.h:13629
@ CATEGORYMODE_MUSIC
Definition: ff_other.h:13637
@ CATEGORYMODE_NUMBER
Definition: ff_other.h:13640
@ CATEGORYMODE_TEXT
Definition: ff_other.h:13634
@ CATEGORYMODE_NONE
Definition: ff_other.h:13631
void SetID(twobyte catID)
Sets the internal category ID.
Definition: ff_other.h:14297
bool IsDefaultTechniqueText()
Returns true if the category is the standard (pre-defined/Finale-created) category "Technique Text".
Definition: ff_other.h:14180
CATEGORY_DEFAULTIDS GetType() const
Returns the original default category ID upon which this category is based. For default categories,...
Definition: ff_other.h:13834
void SetHorizontalJustification(HORIZ_JUSTIFICATION value)
Sets the "Horizontal Justification" in the category definition.
Definition: ff_other.h:14330
twobyte GetHorizontalOffset() const
Gets the "Additional Horizontal Offset" in the category definition.
Definition: ff_other.h:13977
bool GetTextFontInfo(FCFontInfo *pInfo)
Gets the font info for the text font.
Definition: ff_other.h:13989
CATEGORY_DEFAULTIDS
The default/predefined category IDs in Finale.
Definition: ff_other.h:13603
@ DEFAULTCATID_TEMPOALTERATIONS
Definition: ff_other.h:13611
@ DEFAULTCATID_DYNAMICS
Definition: ff_other.h:13605
@ DEFAULTCATID_TECHNIQUETEXT
Definition: ff_other.h:13617
@ DEFAULTCATID_EXPRESSIVETEXT
Definition: ff_other.h:13614
@ DEFAULTCATID_REHEARSALMARK
Definition: ff_other.h:13620
@ DEFAULTCATID_TEMPOMARKS
Definition: ff_other.h:13608
bool SetTextFontInfo(FCFontInfo *pInfo)
Sets the font info for the text font.
Definition: ff_other.h:14032
void SetHorizontalAlignmentPoint(HORIZ_ALIGNMENT value)
Sets the "Horizontal Alignment Point" value in the category definition.
Definition: ff_other.h:14368
bool IsDefaultExpressiveText()
Returns true if the category is the standard (pre-defined/Finale-created) category "Expressive Text".
Definition: ff_other.h:14169
bool UsesNumberFont()
Returns true if the category uses the number font settings.
Definition: ff_other.h:14219
bool IsIdentical(const __FCBase *pObject) const override
Overridden method to provide comparison of category definitions.
Definition: ff_other.h:13776
bool IsDefaultTempoMarks()
Returns true if the category is the standard (pre-defined/Finale-created) category "Tempo Marks".
Definition: ff_other.h:14147
bool IsDefaultTempoAlterations()
Returns true if the category is the standard (pre-defined/Finale-created) category "Tempo Alterations...
Definition: ff_other.h:14158
void SetBreakMMRest(bool state)
Sets the flag for if the category should break multimeasure rests.
Definition: ff_other.h:14279
void SetOverrideStaffList(bool state)
Gets the value for if staff lists are used for this category. Use with care!
Definition: ff_other.h:14288
void SetUserCreated(bool value)
Sets the user-defined state. Use with care!
Definition: ff_other.h:14273
void SetVerticalBaselineOffset(twobyte value)
Sets the vertical "Additional Baseline Offset" value in the category definition.
Definition: ff_other.h:14308
bool GetMusicFontInfo(FCFontInfo *pInfo)
Gets the font info for the music font.
Definition: ff_other.h:14003
void SetStaffListID(twobyte value)
(Only works on Finale 2014b and above.) Sets the staff list ID for the category def.
Definition: ff_other.h:14083
twobyte GetVerticalBaselineOffset() const
Returns the vertical "Additional Baseline Offset" in the category definition.
Definition: ff_other.h:13930
void SetVerticalAlignmentPoint(VERT_ALIGNMENT value)
Sets the vertical alignment point for the category definition positioning.
Definition: ff_other.h:14256
bool IsDefaultRehearsalMarks()
Returns true if the category is the standard (pre-defined/Finale-created) category "Rehearsal Marks".
Definition: ff_other.h:14191
bool UsesMusicFont()
Returns true if the category uses the music font settings.
Definition: ff_other.h:14213
bool IsDefaultDynamics()
Returns true if the category is the standard (pre-defined/Finale-created) category "Dynamics".
Definition: ff_other.h:14136
VERT_ALIGNMENT GetVerticalAlignmentPoint() const
Returns the vertical alignment point for the category definition positioning.
Definition: ff_other.h:13923
void GetName(FCString *pString) const
Gets the name of the category and copies it to an existing string object.
Definition: ff_other.h:13878
FCCategoryDef()
The constructor.
Definition: ff_other.h:13765
twobyte GetID() const
Returns the internal category ID. This is a read-only value.
Definition: ff_other.h:13815
twobyte GetStaffListID() const
(Only works on Finale 2014b and above.) Returns the staff list ID for the category def.
Definition: ff_other.h:13866
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:13644
HORIZ_ALIGNMENT
The horizontal alignment points available to categories and expressions.
Definition: ff_other.h:13700
@ ALIGNHORIZ_CENTERPRIMARYNOTEHEAD
Definition: ff_other.h:13714
@ ALIGNHORIZ_LEFTOFALLNOTEHEAD
Definition: ff_other.h:13705
@ ALIGNHORIZ_STEM
Definition: ff_other.h:13711
@ ALIGNHORIZ_TIMESIGSTART
Definition: ff_other.h:13726
@ ALIGNHORIZ_RIGHTALLNOTEHEADS
Definition: ff_other.h:13720
@ ALIGNHORIZ_CENTEROVERUNDERMUSIC
Definition: ff_other.h:13738
@ ALIGNHORIZ_LEFTBARLINE
Definition: ff_other.h:13723
@ ALIGNHORIZ_CLICKPOS
Definition: ff_other.h:13702
@ ALIGNHORIZ_CENTERALLNOTEHEADS
Definition: ff_other.h:13717
@ ALIGNHORIZ_RIGHTBARLINE
Definition: ff_other.h:13741
@ ALIGNHORIZ_STARTOFMUSIC
Definition: ff_other.h:13732
@ ALIGNHORIZ_LEFTOFPRIMARYNOTEHEAD
Definition: ff_other.h:13708
@ ALIGNHORIZ_CENTERBETWEENBARLINES
Definition: ff_other.h:13735
@ ALIGNHORIZ_AFTERCLEFKEYTIMEREPEAT
Definition: ff_other.h:13729
bool SetNumberFontInfo(FCFontInfo *pInfo)
Sets the font info for the number font.
Definition: ff_other.h:14066
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:14382
Contains a clef change inside a cell. This is an item member in a FCCellClefChanges collection (creat...
Definition: ff_other.h:25850
void SetClefShow(twobyte showstate)
Sets the clef show state.
Definition: finaleframework.cpp:13250
void SetClefPercent(twobyte value)
Set the clef resizing, in percent.
Definition: ff_other.h:25977
TimeEdu32 GetMeasurePos() const override
Returns the measure position (in EDUs) where the clef is placed in the measure.
Definition: ff_other.h:25915
twobyte GetHorizontalOffset() const
Returns the horizontal adjustment for the mid-clef change.
Definition: ff_other.h:25927
twobyte GetVerticalOffset() const
Returns the vertical adjustment for the mid-clef change.
Definition: ff_other.h:25933
bool GetAllowVerticalDrag() const
Returns the "Allow Vertical Drag" setting.
Definition: ff_other.h:25946
bool GetClefAfterBarline() const
Returns true if the clef should appear to the right of the barline. Only affects the first clefs in t...
Definition: ff_other.h:25953
void SetMeasurePos(twobyte value)
Sets the measure position (in EDUs) where the clef is placed in the measure.
Definition: ff_other.h:25971
twobyte GetClefIndex() const
Returns the clef index.
Definition: ff_other.h:25906
twobyte GetClefPercent() const
Returns the clef resizing, in percent.
Definition: ff_other.h:25921
void SetHorizontalOffset(twobyte value)
Sets the horizontal adjustment for the mid-clef change.
Definition: ff_other.h:25983
twobyte GetClefShow() const
Sets the clef display state.
Definition: finaleframework.cpp:13240
bool IsStartClef()
Returns true if it's the starting clef in the cell.
Definition: ff_other.h:26020
void SetClefAfterBarline(bool state)
Sets if the clef should appear to the right of the barline. Only affects the first clefs in the cell.
Definition: ff_other.h:26014
FCCellClefChange()
The constructor.
Definition: finaleframework.cpp:13227
void SetAllowVerticalDrag(bool state)
Sets the "Allow Vertical Drag" setting.
Definition: ff_other.h:26007
void SetVerticalOffset(twobyte value)
Sets the vertical adjustment for the mid-clef change.
Definition: ff_other.h:25989
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:25884
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:25883
void SetClefIndex(twobyte value)
Sets the clef index.
Definition: ff_other.h:25959
Collection class for FCCellClefChange class objects, containing all mid-clef changes in a cell.
Definition: ff_othercollection.h:2247
The class that reference a cell (one measure on one staff) in the musical "grid".
Definition: ff_cell.h:18
Class that stores one record of a chord suffix definition.
Definition: ff_other.h:21677
void SetHorizontalOffset(twobyte value)
Sets the horizontal offset value (from base symbol).
Definition: finaleframework.cpp:11534
bool GetPrefixMinus() const
Returns true if the "prefix with minus" is used.
Definition: finaleframework.cpp:11492
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:21719
bool GetNumberRepresentation() const
Returns true if the symbol is a number instead of a character slot.
Definition: finaleframework.cpp:11374
bool GetPrefixFlat() const
Returns true if the "prefix with flat" is used.
Definition: finaleframework.cpp:11402
void GetFontInfo(FCFontInfo *pFontInfo)
Gets the font information for the chords suffix.
Definition: finaleframework.cpp:11309
bool GetPrefixPlus() const
Returns true if the "prefix with plus" is used.
Definition: finaleframework.cpp:11462
eUniChar32 GetSymbol() const
Returns the suffix character symbols.
Definition: finaleframework.cpp:11346
twobyte GetVerticalOffset() const
Returns the vertical offset value (from base symbol).
Definition: finaleframework.cpp:11549
void SetPrefixSharp(bool state)
Sets if the "prefix with sharp" should be used or not.
Definition: finaleframework.cpp:11447
twobyte GetHorizontalOffset() const
Returns the horizontal offset value (from base symbol).
Definition: finaleframework.cpp:11520
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:21720
void SetVerticalOffset(twobyte value)
Sets the vertical offset value (from base symbol).
Definition: finaleframework.cpp:11563
void SetNumberRepresentation(bool state)
Sets if the symbol is a number or a character slot.
Definition: finaleframework.cpp:11388
void SetSymbol(eUniChar32 symbol)
Sets the suffix character symbols.
Definition: finaleframework.cpp:11360
void SetPrefixFlat(bool state)
Sets if the "prefix with flat" should be used or not.
Definition: finaleframework.cpp:11417
void SetFontInfo(FCFontInfo *pFontInfo)
Sets the font information for the chords suffix.
Definition: finaleframework.cpp:11328
FCChordSuffixElement()
The constructor.
Definition: finaleframework.cpp:11261
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:21852
void SetPrefixMinus(bool state)
Sets if the "prefix with minus" should be used or not.
Definition: finaleframework.cpp:11506
void SetPrefixPlus(bool state)
Sets if the "prefix with plus" should be used or not.
Definition: finaleframework.cpp:11477
bool GetPrefixSharp() const
Returns true if the "prefix with sharp" is used.
Definition: finaleframework.cpp:11432
Data class for the global clef definitions.
Definition: ff_globals.h:51
A collection of __FCCompositeTimeSigBottomElement records.
Definition: ff_other.h:920
int GetGroupElementBeatDuration(int groupindex, int subindex) const
Returns the beat duration for a group element.
Definition: ff_other.h:1114
void SetGroupElementBeatDuration(int groupindex, int subindex, twobyte value)
Sets the beat duration for a group element.
Definition: ff_other.h:1203
virtual ~FCCompositeTimeSigBottom()
The destructor.
Definition: ff_other.h:1059
bool SaveAll() override
Overridden SaveAll method that repacks the composite bottom time sig.
Definition: ff_other.h:1218
int GetGroupCount() const
Calculates and returns the number of top time sig groups.
Definition: ff_other.h:1073
int GetGroupElementCount(int groupindex) const
Returns the number of items in the composite time sig group.
Definition: ff_other.h:1091
bool DeleteGroup(int groupindex)
Deletes a group from the array.
Definition: ff_other.h:1175
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:1046
int GetElementCount() const
Returns the number of array elements for all the bottom time sig digits.
Definition: ff_other.h:1125
bool SaveAllForItem(CMPER cmper) override
Overridden SaveAllForItem method that repacks the composite top time sig according to the cmper.
Definition: ff_other.h:1237
FCCompositeTimeSigBottom()
The constructor.
Definition: ff_other.h:1052
int AddGroup(int elementcount=1)
Adds a group to the end of the top composite time sig.
Definition: ff_other.h:1138
A collection of __FCCompositeTimeSigTopElement records.
Definition: ff_other.h:516
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:636
void SetGroupElementBeatsWithFraction(int groupindex, int subindex, double value)
Sets the beat number for a group element.
Definition: ff_other.h:839
void MergeWithPreviousGroup(int groupindex)
Merges the beat group with the previous beat group, by removing the "start group flag" from the group...
Definition: ff_other.h:719
bool SaveAllForItem(CMPER cmper) override
Overridden SaveAllForItem method that repacks the composite top time sig according to the cmper.
Definition: ff_other.h:884
double GetGroupElementBeatsWithFraction(int groupindex, int subindex) const
Returns the fractional beat number for a group element.
Definition: ff_other.h:796
FCCompositeTimeSigTop()
The constructor.
Definition: ff_other.h:642
bool SaveAll() override
Overridden SaveAll method that repacks the composite top time sig.
Definition: ff_other.h:865
int GetElementCount() const
Returns the number of array elements for all the top time sig digits.
Definition: ff_other.h:811
void SetGroupElementBeats(int groupindex, int subindex, twobyte value)
Sets the beat number for a group element.
Definition: ff_other.h:824
int CalcTotalGroupBeats(int groupindex) const
Returns the accumulated number of beats the composite group element.
Definition: ff_other.h:760
int GetGroupElementBeats(int groupindex, int subindex) const
Returns the beat number for a group element.
Definition: ff_other.h:780
virtual ~FCCompositeTimeSigTop()
The destructor.
Definition: ff_other.h:649
int GetGroupElementCount(int index) const
Returns the number of items in the composite time sig group.
Definition: ff_other.h:736
int GetGroupCount() const
Calculates and returns the number of top time sig groups.
Definition: ff_other.h:663
int AddGroup(int elementcount)
Adds a group to the end of the top composite time sig.
Definition: ff_other.h:681
The class for a "current staff state" (the sum of staff changes and staff style changes) at a specifi...
Definition: ff_other.h:12206
bool LoadForEntry(const FCNoteEntry *pNoteEntry)
Loads the staff spec data based on the position in the note entry.
Definition: finaleframework.cpp:9343
int GetConnectedStaff() const
Returns the connected staff for loaded data.
Definition: ff_other.h:12274
bool LoadForCell(FCCell *pCell, TimeEdu32 durationpos)
Loads the staff spec data based on a position in a cell.
Definition: finaleframework.cpp:9353
int GetConnectedMeasure() const
Returns the connected measure for loaded data.
Definition: ff_other.h:12268
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:12229
int GetConnectedDurationPos() const
Returns the connected duration position for loaded data.
Definition: ff_other.h:12262
Class that allows access to custom key modes. (Finale calls them "Nonstandard Key Signatures",...
Definition: ff_other.h:27298
static bool DeleteItemNo(CMPER itemno)
Class function that deletes all data associated with an item number.
Definition: ff_other.h:27432
void SetBaseTonalCenter(twobyte value)
Sets the base tonal center for the key mode.
Definition: ff_other.h:27783
static std::map< twobyte, twobyte > GetDefaultAccidentalAmounts()
Class method that returns the default accidental amounts for the key signatures in common practice no...
Definition: ff_other.h:28004
void SetMiddleKeyNumber(twobyte value)
Sets the "Middle Key Number" value from the Special Key Signature Attributes dialog.
Definition: ff_other.h:27531
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:27352
std::map< twobyte, twobyte > GetAccidentalOrder() const
Definition: ff_other.h:27844
twobyte GetBaseTonalCenter() const
Returns the base tonal center for the key mode.
Definition: ff_other.h:27761
void SetAccidentalOrder(const std::map< twobyte, twobyte > &values)
Definition: ff_other.h:27910
bool GetHasClefAccidentalPlacements() const
Returns whether the custom key mode has accidental octave placement records.
Definition: ff_other.h:27583
void SetSymbolListID(twobyte value)
Sets the item number (ID) of the custom symbol list for accidentals. (Setting this value to zero caus...
Definition: ff_other.h:27575
static bool CalcIsDefaultAccidentalAmounts(const std::map< twobyte, twobyte > &values)
Class function that returns true if the input accidental amounts match the default setting.
Definition: ff_other.h:28013
std::map< twobyte, twobyte > GetAccidentalAmounts() const
Definition: ff_other.h:27943
std::map< twobyte, twobyte > GetTonalCenters() const
Returns the table of tonal centers by number of sharps/flats.
Definition: ff_other.h:27693
EFONTID GetAccidentalFontID() const
Returns the font ID for accidental symbols.
Definition: ff_other.h:27599
void SetAccidentalAmounts(const std::map< twobyte, twobyte > &values)
Definition: ff_other.h:27996
void SetDiatonicStepsMap(const std::vector< eHarmLev > &list)
Sets a list specifiying the chromatic step where each diatonic step occurs.
Definition: ff_other.h:27682
twobyte GetMiddleKeyNumber() const
Returns the "Middle Key Number" value from the Special Key Signature Attributes dialog.
Definition: ff_other.h:27512
twobyte GetHarmonicReference() const
Returns the "Harmonic Reference" value from the Special Key Signature Attributes dialog.
Definition: ff_other.h:27494
bool SaveNewNonLinear()
saves the current instance as new non-linear custom key mode.
Definition: finaleframework.cpp:13676
static bool CalcIsDefaultClefAccidentalPlacements(const std::vector< std::map< twobyte, twobyte > > &values)
Class function that returns true if the input clef accidental placements match the default setting.
Definition: ff_other.h:28089
bool IsLinear() const
Returns true if this is a linear mode.
Definition: ff_other.h:27472
bool IsPredefined() const
Returns true if this is a predefined mode (major or minor).
Definition: ff_other.h:27486
static std::map< twobyte, twobyte > GetDefaultAccidentalOrder()
Class method that returns the default accidental order for the key signatures in common practice nota...
Definition: ff_other.h:27920
eKey GetKeyID(int accidentalnumber=0) const
Returns the key ID for this custom key mode, based on the input number of sharps or flats (for linear...
Definition: ff_other.h:27448
twobyte GetSymbolListID() const
Returns the item number (ID) of the custom symbol list for accidentals, or zero if none....
Definition: ff_other.h:27565
static std::vector< std::map< twobyte, twobyte > > GetDefaultClefAccidentalPlacements()
Class method that returns the default clef accidental placements for the key signatures in common pra...
Definition: ff_other.h:28060
FCFontInfo * CreateAccidentalFontInfo() const
Creates an instance of FCFontInfo that matches the current setting of GetAccidentalFontID....
Definition: finaleframework.cpp:13693
std::vector< std::map< twobyte, twobyte > > GetClefAccidentalPlacements() const
Definition: ff_other.h:28026
static bool CalcIsDefaultAccidentalOrder(const std::map< twobyte, twobyte > &values)
Class function that returns true if the input accidental order matches the default setting.
Definition: ff_other.h:27929
void SetHasClefAccidentalPlacements(bool state)
Sets whether the custom key mode has accidental octave placement records.
Definition: ff_other.h:27591
void SetGoToKeyUnit(twobyte value)
Sets the "Go to Key Unit" value from the Special Key Signature Attributes dialog.
Definition: ff_other.h:27555
bool SaveNewLinear()
saves the current instance as new linear custom key mode.
Definition: finaleframework.cpp:13658
static std::map< twobyte, twobyte > GetDefaultTonalCenters()
Class method that returns the default tonal centers for the major mode in common practice notation.
Definition: ff_other.h:27821
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:27353
void SetTotalChromaticSteps(twobyte value)
Sets the "Total Steps" value from the Key Step Map dialog.
Definition: ff_other.h:27650
static bool CalcIsDefaultTonalCenters(const std::map< twobyte, twobyte > &values)
Class function that returns true if the input tonal centers match the default setting.
Definition: ff_other.h:27830
void SetTonalCenters(const std::map< twobyte, twobyte > &values)
Sets the table of tonal centers by number of sharps/flats.
Definition: ff_other.h:27751
twobyte GetTotalChromaticSteps() const
Returns the "Total Steps" value from the Key Step Map dialog.
Definition: ff_other.h:27637
void SetHarmonicReference(twobyte value)
Sets the "Harmonic Reference" value from the Special Key Signature Attributes dialog.
Definition: ff_other.h:27504
twobyte GetGoToKeyUnit() const
Returns the "Go to Key Unit" value from the Special Key Signature Attributes dialog.
Definition: ff_other.h:27539
FCCustomKeyModeDef()
The constructor.
Definition: ff_other.h:27359
bool IsNonLinear() const
Returns true if this is a non-linear mode.
Definition: ff_other.h:27480
void SetAccidentalFontID(const EFONTID value)
Sets the font ID for accidental symbols.
Definition: ff_other.h:27611
FCKeySignature * CreateKeySignature(eHarmAlt alteration=0) const
Creates a FCKeySignature instance for this custom key signature.
Definition: finaleframework.cpp:13707
std::vector< eHarmLev > GetDiatonicStepsMap() const
Returns a list specifying the chromatic step where each diatonic step occurs.
Definition: ff_other.h:27670
void SetClefAccidentalPlacements(const std::vector< std::map< twobyte, twobyte > > &values)
Definition: ff_other.h:28050
Class that encapsulates the list of accidental symbols for instances of FCCustomKeyModeDef....
Definition: ff_other.h:27131
bool LoadFirst()
Loads the first item.
Definition: finaleframework.cpp:13434
bool CalcIsDefaultList() const
Calculates if this is equal to the default symbol list.
Definition: finaleframework.cpp:13519
FCCustomKeyModeSymbolList()
the constructor.
Definition: ff_other.h:27153
bool Save()
Saves the item.
Definition: finaleframework.cpp:13451
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:27142
bool DeleteData()
Delete the item from the Finale document.
Definition: finaleframework.cpp:13472
bool SaveAs(CMPER itemno)
Saves the item with a new ID. If the ID exists, it will be overwritten with the list from this instan...
Definition: ff_other.h:27187
bool LoadNext()
Loads the next item.
Definition: finaleframework.cpp:13443
void SetList(symbolMap list)
Sets a list of strings that represent the symbols for each sharp, flat, or natural alteration.
Definition: ff_other.h:27230
static symbolMap GetDefaultList()
Class function that returns a fully-populated default symbol list, based on the current document sett...
Definition: finaleframework.cpp:13496
symbolMap GetList() const
Returns a list of strings that represent the symbols for each sharp, flat, or natural alteration.
Definition: ff_other.h:27214
FCString * CreateListString() const
Returns a string of all the accidental symbol strings separated by spaces. This could be used as a de...
Definition: finaleframework.cpp:13478
CMPER GetItemNo() const
Gets the item number. This value is meaningless if the instance has neither been loaded or saved.
Definition: ff_other.h:27204
bool Load(CMPER itemno)
Loads the data for a given item.
Definition: finaleframework.cpp:13417
Class to encapsulate enclosures (available for example in expressions and measure numbers....
Definition: ff_other.h:2872
int GetLineWidth() const
Returns the line width (in 64ths of an EVPUs).
Definition: ff_other.h:3253
void SetOpaque(bool state)
Sets the "opaque" state.
Definition: ff_other.h:3171
void SetMode(ENCLOSUREMODES enclosuremode)
Set the enclosure sizing option.
Definition: ff_other.h:3205
void SetRoundedCornerRadius(Efix32 radius)
Sets the corner radius (in EFIXes) for rounded corners on Finale 25.4 and above.
Definition: ff_other.h:3196
ENCLOSUREMODES
The enclosure sizing options.
Definition: ff_other.h:3021
@ ENCLOSUREMODE_MINWIDTH
Definition: ff_other.h:3026
@ ENCLOSUREMODE_NONE
Definition: ff_other.h:3023
@ ENCLOSUREMODE_MATCHDIMENSIONS
Definition: ff_other.h:3029
void SetHorizontalOffset(int offset)
Sets the horizontal offset.
Definition: ff_other.h:3119
bool SaveAs(CMPER itemno) override
Overridden version of SaveAs.
Definition: ff_other.h:3369
bool GetOpaque() const
Returns the "opaque" state.
Definition: ff_other.h:3315
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:2970
void SetRoundedCorners(bool state)
Sets if rounded corners should be used (on Finale 25.4 and later) for the enclosure.
Definition: ff_other.h:3184
void SetHorizontalMargin(int margin)
Sets the horizontal margin (which is half the width value in the enclosure dialog box).
Definition: ff_other.h:3140
void SetVerticalOffset(int offset)
Sets the vertical offset.
Definition: ff_other.h:3129
void _AssignEDTEnclosure(void *pPointer)
For internal use ONLY! Assigns enclosure data to the class (for structures that doesn't load their ow...
Definition: ff_other.h:3070
bool GetFixedSize() const
Returns the "fixed size" state.
Definition: ff_other.h:3305
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:2969
void SetFixedSize(bool state)
Sets the "fixed size" state.
Definition: ff_other.h:3161
ENCLOSURESHAPE GetShape() const
Returns the shape of the enclosure.
Definition: ff_other.h:3242
int GetHorizontalOffset() const
Returns the horizontal offset.
Definition: ff_other.h:3263
void SetLineWidth(int width)
Sets the line width (in 64ths of a EVPUs).
Definition: ff_other.h:3109
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:3377
void SetVerticalMargin(int margin)
Sets the vertical margin (which is half the height value in the enclosure dialog box).
Definition: ff_other.h:3151
bool GetRoundedCorners() const
Returns if rounded corners should be used (on Finale 25.4 and later) for the enclosure.
Definition: ff_other.h:3329
ENCLOSURESHAPE
The enclosure shapes.
Definition: ff_other.h:2990
@ ENCLOSURE_ELLIPSE
Definition: ff_other.h:2998
@ ENCLOSURE_PENTAGON
Definition: ff_other.h:3007
@ ENCLOSURE_DIAMOND
Definition: ff_other.h:3004
@ ENCLOSURE_OCTAGON
Definition: ff_other.h:3016
@ ENCLOSURE_TRIANGLE
Definition: ff_other.h:3001
@ ENCLOSURE_RECTANGLE
Definition: ff_other.h:2995
@ ENCLOSURE_NONE
Definition: ff_other.h:2992
@ ENCLOSURE_SEPTAGON
Definition: ff_other.h:3013
@ ENCLOSURE_HEXAGON
Definition: ff_other.h:3010
ENCLOSUREMODES GetMode() const
Returns the enclosure sizing option.
Definition: ff_other.h:3357
int GetVerticalOffset() const
Returns the vertical offset.
Definition: ff_other.h:3273
int GetHorizontalMargin() const
Returns the horizontal margin (which is half the width value in the enclosure dialog box).
Definition: ff_other.h:3284
Efix32 GetRoundedCornerRadius() const
Returns the corner radius (in EFIXes) for rounded corners on Finale 25.4 and above.
Definition: ff_other.h:3342
void SetShape(ENCLOSURESHAPE shape)
Sets the shape for the enclosure.
Definition: ff_other.h:3088
FCEnclosure()
The constructor.
Definition: ff_other.h:3050
int GetVerticalMargin() const
Returns the vertical margin (which is half the height value in the enclosure dialog box).
Definition: ff_other.h:3295
The class for a start of repeat bracket in the document. There can only be one ending repeat in each ...
Definition: ff_other.h:22668
void SetVerticalTopBracketPosition(Evpu16 position)
Sets the top vertical position of the repeat bracket.
Definition: ff_other.h:22933
void SetVerticalLeftBracketPosition(Evpu16 position)
Sets the vertical position of the repeat bracket's left side.
Definition: ff_other.h:22951
bool GetVisible() const
Returns true if the repeat is visible. ("Show" is checked in the context menu.)
Definition: ff_other.h:22764
eMeas GetTargetMeasure() const
Returns the target measure number.
Definition: ff_other.h:22743
bool DeepDeleteData() override
Reimplementation of DeepDeleteData(). Deletes both the basic repeat ending data and the optional repe...
Definition: finaleframework.cpp:12464
FCEndingRepeat()
The constructor.
Definition: ff_other.h:22703
void SetVisible(bool state)
Sets if the repeat is visible. ("Show" is checked in the context menu.)
Definition: ff_other.h:22924
void SetSkipOnIgnore(bool state)
Returns the "Skip ending if ignoring repeats" setting.
Definition: ff_other.h:22896
Evpu16 GetVerticalTopBracketPosition() const
Returns the top vertical position of the bracket.
Definition: ff_other.h:22773
void SetStaffListID(twobyte list)
Sets the staff list ID to be used.
Definition: ff_other.h:22885
Evpu16 GetHorizontalLeftBracketPosition() const
Returns the horizontal position of the bracket's left side.
Definition: ff_other.h:22782
FCString * CreateTextString()
Loads the text for an ending repeat and returns it in a FCString object.
Definition: finaleframework.cpp:12523
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:22688
Evpu16 GetHorizontalTextPosition() const
Returns the horizontal position of the repeat text.
Definition: ff_other.h:22818
FCSeparatePlacements * CreateTextSeparatePlacements()
Creates a FCSeparatePlacements collection and loads it with all matching independent positioning reco...
Definition: finaleframework.cpp:12608
bool SetPassNumbers(FCNumbers *pNumbers)
Sets the pass numbers for the repeat ending.
Definition: finaleframework.cpp:12552
Evpu16 GetVerticalTextPosition() const
Returns the vertical position of the repeat text.
Definition: ff_other.h:22827
void SetVerticalTextPosition(Evpu16 position)
Sets the vertical position of the repeat text.
Definition: ff_other.h:22987
bool DeepSaveAs(CMPER itemno) override
Reimplementation of DeepDeleteAs(). Saves both the basic repeat ending data and the optional repeat t...
Definition: finaleframework.cpp:12475
FCTextRepeat::REPSHOWMODES GetShowMode() const
Returns where the ending repeat should be shown.
Definition: finaleframework.cpp:12491
void SetShowMode(FCTextRepeat::REPSHOWMODES mode)
Sets where the ending repeat should be shown.
Definition: finaleframework.cpp:12498
Evpu16 GetVerticalRightBracketPosition() const
Returns the vertical position of the bracket's right side.
Definition: ff_other.h:22809
void SetTargetTrigger(FCTextRepeat::REPTARGETTRIGGERS value)
Set the target trigger for the ending repeat. This method should also be combined with a SetTargetMea...
Definition: ff_other.h:23066
void SetHorizontalLeftBracketPosition(Evpu16 position)
Sets the horizontal position of the repeat bracket's left side.
Definition: ff_other.h:22942
void SetHorizontalTextPosition(Evpu16 position)
Sets the horizontal position of the repeat text.
Definition: ff_other.h:22978
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:22689
Evpu16 GetVerticalLeftBracketPosition() const
Returns the vertical position of the bracket's left side.
Definition: ff_other.h:22791
bool GetSkipOnIgnore() const
Returns the "Skip ending if ignoring repeats" setting.
Definition: ff_other.h:22734
Evpu16 GetHorizontalRightBracketPosition() const
Returns the horizontal position of the bracket's right side.
Definition: ff_other.h:22800
void SetHorizontalRightBracketPosition(Evpu16 position)
Sets the horizontal position of the repeat bracket's right side.
Definition: ff_other.h:22960
void SetIndividualPositioning(bool state)
Sets if the repeat bracket has individual staff positioning enabled or not.
Definition: ff_other.h:22915
bool GetPassNumbers(FCNumbers *pNumbers)
Fills the pass numbers in a FCNumbers collection.
Definition: finaleframework.cpp:12540
twobyte GetStaffListID() const
Returns the staff list ID to be used for the text repeat assignment.
Definition: ff_other.h:22728
int GetPassNumbersCount() const
Returns the number of pass numbers available to the ending repeat.
Definition: ff_other.h:22849
FCSeparatePlacements * CreateSeparatePlacements()
Creates a FCSeparatePlacements collection and loads it with all matching independent positioning reco...
Definition: finaleframework.cpp:12594
FCTextRepeat::REPTARGETTRIGGERS GetTargetTrigger() const
Returns the target trigger for the ending repeat. This value also affects how the GetTargetMeasure() ...
Definition: ff_other.h:22864
bool GetIndividualPositioning() const
Returns true if the bracket has individual staff positioning enabled.
Definition: ff_other.h:22752
void SetTargetMeasure(eMeas measure)
Returns the target measure number. The value is dependent on GetTargetTrigger(), which is set with Se...
Definition: ff_other.h:22906
bool SaveTextString(FCString *pString)
Saves a FCString object for the ending repeat.
Definition: finaleframework.cpp:12531
void SetVerticalRightBracketPosition(Evpu16 position)
Sets the vertical position of the repeat bracket's right side.
Definition: ff_other.h:22969
The class for an executable shape definition.
Definition: ff_other.h:21590
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:21655
twobyte GetShapeID()
Returns the shape ID that is connected to the executable shape.
Definition: ff_other.h:21648
void SetShapeID(twobyte shapeID)
Sets the shape ID that is connected to the executable shape.
Definition: ff_other.h:21652
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:21630
FCExecutableShapeDef()
The constructor.
Definition: ff_other.h:21644
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:21629
Class for expression assignments to a measure/staff.
Definition: ff_other.h:17641
bool IsSingleStaffAssigned()
Returns true if the expression is assigned to a single staff.
Definition: ff_other.h:17996
twobyte GetGraceNoteIndex() const
Returns the grace note index that the expression is connected to.
Definition: ff_other.h:17939
bool GetVisible() const
Returns the display state of the expression (relative to the active part).
Definition: ff_other.h:17903
void SetScaleWithEntry(bool state)
Sets if the expression should scale to entry.
Definition: ff_other.h:18167
void SetMeasurePos(TimeEdu32 value)
Sets the expression position in EDUs.
Definition: ff_other.h:18173
twobyte GetLayerAssignment() const
Returns the layer that the expression is assigned to.
Definition: ff_other.h:17818
void SetScoreAssignment(bool value)
Sets if the expression is assigned to the score.
Definition: ff_other.h:18051
void ResetPos()
Resets the position of the expression.
Definition: ff_other.h:17744
void SetPlaybackLayerAssignment(twobyte layer)
Sets the layer that the playback of the expression is assigned to.
Definition: ff_other.h:18075
bool AssignTextExpressionDef(FCTextExpressionDef *pDef)
Assigns a saved text expression definition to an expression.
Definition: finaleframework.cpp:11617
void SetHorizontalPos(twobyte value)
Sets the horizontal position offset, in EVPUs.
Definition: ff_other.h:18185
twobyte GetStaffGroupID() const
Returns the "staff group" ID for the staff, which is used for expressions that are one unity in a sta...
Definition: ff_other.h:17888
bool AssignShapeExpressionDef(FCShapeExpressionDef *pDef)
Assigns a saved shape expression definition to an expression.
Definition: finaleframework.cpp:11626
eMeas GetMeasure() const override
Returns the 1-based measure number that the expression is assigned to.
Definition: ff_other.h:17810
bool IsShape() const
Returns true if the expression is a shape expression.
Definition: ff_other.h:17987
eStaff CalcStaffInCurrentView() const
Calculates the 1-based staff number that the expression is assigned to in the current view.
Definition: finaleframework.cpp:11675
bool GetPartAssignment() const
Returns true if the expression is assigned to the parts.
Definition: ff_other.h:17868
EXPRESSION_PLAYBACK_STARTPOINTS GetPlaybackStart() const
Returns the playback start point for the expression.
Definition: ff_other.h:17847
twobyte GetID() const
Returns the definition ID for the shape or text expresion.
Definition: ff_other.h:18015
bool HasStaffValue() const override
Overridden version, since this class supports staff returns.
Definition: ff_other.h:17802
TimeEdu32 GetMeasurePos() const override
Returns the expression position in EDUs.
Definition: ff_other.h:17916
void SetVisible(bool state)
Sets the display state of the expression (relative to the active part).
Definition: ff_other.h:18161
twobyte GetStaffListID() const
Returns the staff list ID for the expression.
Definition: ff_other.h:17881
FCShapeExpressionDef * CreateShapeExpressionDef()
Creates a shape expression definition object for the expression.
Definition: finaleframework.cpp:11589
void SetPartAssignment(bool value)
Sets if the expression is assigned to the parts.
Definition: ff_other.h:18060
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:17686
void SetID(twobyte id)
Sets the definition ID for the shape or text expresion.
Definition: ff_other.h:18032
void SetStaffListID(twobyte ID)
Sets the staff list ID for the expression.
Definition: ff_other.h:18139
void SetGraceNoteIndex(twobyte index)
Sets the grace note index, for when expression are connected to grace notes.
Definition: ff_other.h:18199
void SetPlaybackStart(EXPRESSION_PLAYBACK_STARTPOINTS value)
Sets the playback start point for the expression.
Definition: ff_other.h:18089
FCExpression()
The constructor.
Definition: ff_other.h:17704
bool IsVisibleOnStaff(twobyte staff)
Returns true if the expression is displayed on the staff. This method takes both individual expressio...
Definition: finaleframework.cpp:11581
void SetShape(bool isshape)
Marks the expression as a shape or a text expression.
Definition: ff_other.h:18131
eStaff CalcStaffInPageView() const
Calculates the 1-based staff number that the expression is assigned to, taking into account assignmen...
Definition: finaleframework.cpp:11636
twobyte GetRehearsalMarkOffset() const
Returns the rehearsal mark offset.
Definition: ff_other.h:17896
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:18205
bool CalcMetricPos(FCPoint *pPoint)
Calculates the metric position for an expression in the current layout. The position is in page coord...
Definition: finaleframework.cpp:11684
FCTextExpressionDef * CreateTextExpressionDef()
Creates a text expression definition object for the expression.
Definition: finaleframework.cpp:11601
twobyte GetStaff() const override
Returns the 1-based staff number that the expression is assigned to.
Definition: ff_other.h:17758
eStaff CalcStaffInScrollView() const
Calculates the 1-based staff number that the expression is assigned to, taking into account assignmen...
Definition: finaleframework.cpp:11655
void SetVerticalPos(twobyte value)
Sets the vertical position offset, in EVPUs.
Definition: ff_other.h:18193
void SetLayerAssignment(twobyte layer)
Sets the layer that the expression is assigned to.
Definition: ff_other.h:18040
void SetRehearsalMarkOffset(twobyte value)
Sets the rehearsal mark offset.
Definition: ff_other.h:18154
EXPRESSION_PLAYBACK_STARTPOINTS
Constants for GetPlaybackStart() and SetPlaybackStart().
Definition: ff_other.h:17673
@ EXPRPLAYSTART_POSINMEASURE
Definition: ff_other.h:17675
@ EXPRPLAYSTART_BEGINNINGOFMEASURE
Definition: ff_other.h:17681
@ EXPRPLAYSTART_ALIGNMENTPOINT
Definition: ff_other.h:17678
void SetStaff(twobyte staffno)
Sets the assigned staff.
Definition: ff_other.h:18121
twobyte GetHorizontalPos() const
Returns the horizontal offset position in EVPUs.
Definition: ff_other.h:17925
twobyte GetVerticalPos() const
Returns the vertical offset position in EVPUs.
Definition: ff_other.h:17933
EXTAG Tag() const override
The Enigma tag for the derived class.
Definition: ff_other.h:17688
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:17685
bool GetShape() const
Identical to IsShape().
Definition: ff_other.h:18003
void SetStaffGroupID(twobyte value)
Sets the "staff group" ID for the staff, which is used for expressions that are one unity in a staff ...
Definition: ff_other.h:18146
twobyte GetPlaybackLayerAssignment() const
Returns the layer that the playback of the expression is assigned to.
Definition: ff_other.h:17831
bool GetScoreAssignment() const
Returns true if the expression is assigned to the score.
Definition: ff_other.h:17858
bool SaveNewToCell(FCCell *pCell)
Saves an expression to a single cell. It also automatically sets the expression attribute for the mea...
Definition: finaleframework.cpp:11698
bool GetScaleWithEntry() const
Returns if the expression should scale to entry or not.
Definition: ff_other.h:17910
Collection class for FCExpression class objects.
Definition: ff_othercollection.h:890
Class for document-independent font information.
Definition: ff_base.h:1138
void ParseEnigmaFont(const EEnigmaFont *pEnigmaFont)
Transfers the info from a Finale-internal font structure to the FCFontInfo object.
Definition: ff_base.h:1456
void SetNameByID(EFONTID id)
Sets the font name by using the document's internal Enigma font ID.
Definition: finaleframework.cpp:3671
void SetSize(int fontsize)
Sets the font size as an integer value.
Definition: ff_base.h:1546
FLAG_16 GetEnigmaStyles() const
Gets the font style as standard Enigma bit storage.
Definition: ff_base.h:1358
int GetSize() const
Returns the font size as an integer number.
Definition: ff_base.h:1289
void SetFontID(EFONTID fontID)
Sets the internal document-specific font ID.
Definition: ff_base.h:1525
void SetEnigmaStyles(FLAG_16 fontstyles)
Sets the font style as standard Enigma bit storage.
Definition: ff_base.h:1469
EFONTID GetIDByName() const
Gets the internal Enigma font ID for the current document by searching for the font name....
Definition: finaleframework.cpp:3579
Class for freezing a system at a specific measure.
Definition: ff_other.h:14410
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:14489
FCFreezeSystem()
The constructor.
Definition: ff_other.h:14460
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:14443
twobyte GetNextSysMeasure() const
Returns the start measure for the subsequent system after the system's frozen measures.
Definition: ff_other.h:14485
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:14444
void SetNextSysMeasure(twobyte measure)
Sets the start measure for the subsequent system.
Definition: ff_other.h:14476
Class for tablature instruments definitions.
Definition: ff_other.h:25427
bool SetDiatonicInfo(FCNumbers *pNumbers)
Sets the diatonic steps info, based on the numbers of a FCNumbers collection.
Definition: ff_other.h:25790
twobyte GetStringTuning(int stringnumber)
Returns the MIDI number for a specific open string's tuning.
Definition: ff_other.h:25684
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:25517
bool SetStringTuning(int stringnumber, twobyte midinumber)
Sets the MIDI number for a specific open string's tuning.
Definition: ff_other.h:25712
bool GetDiatonicInfo(FCNumbers *pNumbers)
Fills a number collection with all the defined diatonic steps.
Definition: ff_other.h:25764
twobyte GetFretCount() const
Returns the number of frets for the instrument definition.
Definition: ff_other.h:25566
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:25516
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:25813
twobyte GetStringCount() const
Returns the number of strings for the instrument definition.
Definition: ff_other.h:25584
bool GetName(FCString *pString)
Gets the name of the fretted instrument definition.
Definition: ff_other.h:25630
bool SetName(FCString *pString)
Sets the name of the fretted instrument definition.
Definition: ff_other.h:25657
bool LoadNext() override
Overridden version of LoadNext, to work with FCFretInstrumentDefs::LoadAll()
Definition: ff_other.h:25523
void SetStringCount(twobyte count)
Sets the number of strings for the instrument definition.
Definition: ff_other.h:25595
int GetDiatonicCount()
Returns the number of diatonic steps that are defined for the instrument.
Definition: ff_other.h:25744
bool LoadFirst() override
Overridden version of LoadFirst, to work with FCFretInstrumentDefs::LoadAll()
Definition: ff_other.h:25520
void SetFretCount(twobyte count)
Sets the number of frets for the instrument definition.
Definition: ff_other.h:25575
void SetSpeedyClef(eClef clef)
Sets the clef number to be used in Speedy Edit.
Definition: ff_other.h:25615
eClef GetSpeedyClef() const
Returns the clef number to be used in Speedy Edit.
Definition: ff_other.h:25606
bool IsDiatonic()
Returns if the instrument has diatonic fretboard information defined or not.
Definition: ff_other.h:25735
FCFretInstrumentDef()
The constructor.
Definition: ff_other.h:25543
Class that stores one record of a fretboard chord definition.
Definition: ff_other.h:22540
void SetFretInstrumentID(CMPER value)
Sets the ID for the FCFretInstrumentDef associated with this group.
Definition: ff_other.h:22629
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:22566
FCFretInstrumentDef * CreateFretInstrumentDef() const
Creates the associated instance of FCFretInstrumentDef.
Definition: finaleframework.cpp:12386
CMPER GetFretInstrumentID() const
Returns the ID for the FCFretInstrumentDef associated with this group.
Definition: ff_other.h:22623
twobyte _GetInci()
Returns the inci for the fretboard (which indicates the alternate version of a fretboard).
Definition: ff_other.h:22589
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:22644
void GetName(FCString *pString) const
Gets the name of the fretboard group.
Definition: ff_other.h:22635
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:22567
void SetName(const FCString *pString)
Sets the name of the fretboard group.
Definition: ff_other.h:22641
FCFretboardGroup * CreateFretboardGroup() const
Creates the associated instance of FCFretboardGroup.
Definition: finaleframework.cpp:12397
bool LoadFirst() override
Loads the very first element in the database, if any.
Definition: ff_other.h:22582
FCFretboardGroupDef()
The constructor.
Definition: ff_other.h:22580
Class that represents a fretboard group. A correctly constructed fretboard group has exactly 12 FCFre...
Definition: ff_detailscollection.h:476
The class for a fretboard style definition, which reflects the content the "Fretboard Style" dialog b...
Definition: ff_other.h:21995
void SetFingeredShapeID(twobyte value)
Sets the shape ID of the "fingered" shape.
Definition: ff_other.h:22455
void GetName(FCString *pString) const
Copies the style name to a FCString object.
Definition: ff_other.h:22070
bool GetShowLastFret() const
Returns if the last fret should be shown when drawing the fretboards, or not.
Definition: ff_other.h:22178
void SetNutThickness(Efix32 value)
Sets the nut thickness, in EFIXes.
Definition: ff_other.h:22332
void SetFretNumberText(const FCString *pString)
Sets the fret number text, using a FCString object.
Definition: ff_other.h:22394
void SetHorizontalFingeringOffset(Efix32 value)
Sets the horizontal offset for fingering numbers, in EFIXes.
Definition: ff_other.h:22342
void GetFingeringFontInfo(FCFontInfo *pFontInfo)
Copies the fingering font information to a FCFontInfo object.
Definition: ff_other.h:22245
void SetFretNumberFontInfo(FCFontInfo *pFontInfo)
Copies the fret number font information fro a FCFontInfo object.
Definition: ff_other.h:22516
void SetFretThickness(Efix32 value)
Sets the fret thickness, in EFIXes.
Definition: ff_other.h:22322
FCFretboardStyleDef()
The constructor.
Definition: ff_other.h:22053
int GetFretCountDefault() const
Returns the default number of frets for the style.
Definition: ff_other.h:22172
twobyte GetOpenStringShapeID() const
Returns the shape ID of the "open string" shape.
Definition: ff_other.h:22207
twobyte GetMuteStringShapeID() const
Returns the shape ID of the "mute string" shape.
Definition: ff_other.h:22216
void SetVerticalFretNumberOffset(Efix32 value)
Sets the vertical text offset for fret number text, in EFIXes.
Definition: ff_other.h:22419
void SetCustomShapeID(twobyte value)
Sets the shape ID of the "custom" shape.
Definition: ff_other.h:22491
void SetBarreShapeID(twobyte value)
Sets the shape ID of the "barre" shape.
Definition: ff_other.h:22482
Efix32 GetFretThickness() const
Returns the fret thickness, in EFIXes.
Definition: ff_other.h:22102
Efix32 GetVerticalHandleOffset() const
Returns the vertical handle offset, in EFIXes.
Definition: ff_other.h:22138
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:22525
void SetHorizontalFretNumberOffset(Efix32 value)
Sets the horizontal text offset for fret number text, in EFIXes.
Definition: ff_other.h:22409
void SetMuteStringShapeID(twobyte value)
Sets the shape ID of the "mute string" shape.
Definition: ff_other.h:22473
void SetOpenStringShapeID(twobyte value)
Sets the shape ID of the "open string" shape.
Definition: ff_other.h:22464
Efix32 GetNutThickness() const
Returns the nut thickness, in EFIXes.
Definition: ff_other.h:22108
void GetFretNumberText(FCString *pString) const
Copies the fret number text to a FCString object.
Definition: ff_other.h:22146
Efix32 GetVerticalFingeringOffset() const
Returns the vertical offset for fingering numbers, in EFIXes.
Definition: ff_other.h:22120
twobyte GetCustomShapeID() const
Returns the shape ID of the "custom" shape.
Definition: ff_other.h:22234
Efix32 GetFingeringWhiteout() const
Returns the whiteout for fingering numbers, in EFIXes.
Definition: ff_other.h:22126
void SetStringSpacing(Efix32 value)
Sets the string spacing, in EFIXes.
Definition: ff_other.h:22292
Efix32 GetVerticalFretNumberOffset() const
Returns the vertical text offset for fret number text, in EFIXes.
Definition: ff_other.h:22166
Efix32 GetFretSpacing() const
Returns the fret spacing, in EFIXes.
Definition: ff_other.h:22096
Efix32 GetHorizontalFingeringOffset() const
Returns the horizontal offset for fingering numbers, in EFIXes.
Definition: ff_other.h:22114
void SetVerticalHandleOffset(Efix32 value)
Sets the vertical handle offset, in EFIXes.
Definition: ff_other.h:22382
void SetVerticalFingeringOffset(Efix32 value)
Sets the vertical offset for fingering numbers, in EFIXes.
Definition: ff_other.h:22352
void SetFingeringFontInfo(FCFontInfo *pFontInfo)
Copies the fingering font information from a FCFontInfo object.
Definition: ff_other.h:22502
bool GetDrawFingeringWhite() const
Returns if the fingering numbers should be drawn in white.
Definition: ff_other.h:22192
twobyte GetFingeredShapeID() const
Returns the shape ID of the "fingered" shape.
Definition: ff_other.h:22198
void SetRotate(bool state)
Sets if the fret should be rotated or not.
Definition: ff_other.h:22443
void SetFretCountDefault(int value)
Sets the default number of frets for the style.
Definition: ff_other.h:22429
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:22035
Efix32 GetHorizontalHandleOffset() const
Returns the horizontal handle offset, in EFIXes.
Definition: ff_other.h:22132
void SetFingeringWhiteout(Efix32 value)
Sets the whiteout for fingering numbers, in EFIXes.
Definition: ff_other.h:22362
bool GetRotate() const
Returns if the fret should be rotated or not.
Definition: ff_other.h:22186
void SetDrawFingeringWhite(bool state)
Sets if the fingering numbers should be drawn in white.
Definition: ff_other.h:22449
void SetFretSpacing(Efix32 value)
Sets the fret spacing, in EFIXes.
Definition: ff_other.h:22312
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:22036
void GetFretNumberFontInfo(FCFontInfo *pFontInfo)
Copies the fret number font information to a FCFontInfo object.
Definition: ff_other.h:22259
void SetName(const FCString *pString)
Sets the style name, by using a FCString object.
Definition: ff_other.h:22277
Efix32 GetStringSpacing() const
Returns the string spacing, in EFIXes.
Definition: ff_other.h:22084
Efix32 GetStringThickness() const
Returns the string thickness, in EFIXes.
Definition: ff_other.h:22090
void SetShowLastFret(bool state)
Sets if the last fret should be shown when drawing the fretboards, or not.
Definition: ff_other.h:22435
Efix32 GetHorizontalFretNumberOffset() const
Returns the horizontal text offset for fret number text, in EFIXes.
Definition: ff_other.h:22160
void SetStringThickness(Efix32 value)
Sets the string thickness, in EFIXes.
Definition: ff_other.h:22302
void SetHorizontalHandleOffset(Efix32 value)
Sets the horizontal handle offset, in EFIXes.
Definition: ff_other.h:22372
twobyte GetBarreShapeID() const
Returns the shape ID of the "barre" shape.
Definition: ff_other.h:22225
The class for a guide in the document.
Definition: ff_other.h:26035
Efix32 GetPosition() const
Returns the position for a guide, if EFIXes.
Definition: ff_other.h:26056
FCGuide(Efix32 position)
The constructor.
Definition: ff_other.h:26042
void SetPosition(Efix32 value)
Sets the position for a guide, if EFIXes.
Definition: ff_other.h:26064
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:26046
The class for an instrument definition item (in the instrument list/Score Manager).
Definition: ff_other.h:24413
FCInstrumentDef()
The constructor.
Definition: ff_other.h:24457
void SetPercussionMapID(twobyte mapID)
Set the percussion mapping ID for the virtual instrument.
Definition: ff_other.h:24503
twobyte GetPercussionMapID() const
Returns the percussion mapping ID for the instrument.
Definition: ff_other.h:24495
FCPercussionMapNotes * CreatePercussionMapNotes()
Loads and make a collection with all the percussion notes for the current percussion MIDI map....
Definition: finaleframework.cpp:12235
FCString * CreateNameString()
Creates a string with the name of the instrument engine.
Definition: ff_other.h:24470
bool GetPercussionMapLocation(void *pFileSpecLocation, FCString *pMapName, EVERSION finpathspecversion)
Returns the location and map name for the current percussion MIDI Map.
Definition: finaleframework.cpp:12350
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:24440
twobyte GetVirtualChannel() const
Returns the virtual channel number for the instrument.
Definition: ff_other.h:24487
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:24439
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:24536
Text used for an instrument definition. Please refer to the FCInstrumentDef class.
Definition: ff_text.h:363
The class for instrument playback data. This is also the link between staves/staff styles and the FCI...
Definition: ff_other.h:24668
FCLayerPlaybackData * GetChordLayerData()
Returns the chord playback layer object (of the FCLayerPlaybackData class).
Definition: ff_other.h:24734
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:24698
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:24793
FCLayerPlaybackData * GetNoteLayerData(int layernumber)
Returns the MIDI expression playback layer object (of the FCLayerPlaybackData class).
Definition: ff_other.h:24782
FCLayerPlaybackData * GetMidiExpressionLayerData()
Returns the MIDI expression playback layer object (of the FCLayerPlaybackData class).
Definition: ff_other.h:24757
FCInstrumentPlaybackData()
The constructor.
Definition: ff_other.h:24716
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:24699
Class for key signatures. Instances of this class are auto-created by FCMeasure:GetKeySignature and F...
Definition: ff_keysig.h:25
void SetID(eKey newkey)
Sets the key signature ID.
Definition: ff_keysig.h:79
Helper class for FCInstrumentPlaybackData, providing the playback data for the Chord Layer,...
Definition: ff_other.h:24586
void SetSolo(bool state)
Sets the "Solo" state of the layer.
Definition: ff_other.h:24654
void SetInstrumentDefID(ePlaybackRoute value)
Set the ID that maps to the FCInstrumentDef class.
Definition: ff_other.h:24634
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:24597
void SetPlay(bool state)
Sets the "Play" state of the layer.
Definition: ff_other.h:24645
ePlaybackRoute GetInstrumentDefID() const
Returns the ID that maps to the FCInstrumentDef class.
Definition: ff_other.h:24603
FCLayerPlaybackData(__EDTLayerPlayData *pData)
The constructor.
Definition: ff_other.h:24593
bool GetSolo() const
Returns the "Solo" state of the layer.
Definition: ff_other.h:24623
bool GetPlay() const
Returns the "Play" state of the layer.
Definition: ff_other.h:24614
The class for a measure (the full vertical measure stack) in the document. It maps the Measure Attrib...
Definition: ff_other.h:4221
bool GetSystemBreak() const
Gets the system break state for the measure.
Definition: ff_other.h:4996
void SetForwardRepeat(bool state)
Sets if a forward repeat should be displayed for the measure or not.
Definition: ff_other.h:4594
void SetChordFlag(bool state)
Set to true if chords are available anywhere in the measure.
Definition: ff_other.h:4928
bool GetPositionEvenly() const
Gets the state of the "Position Evenly across Measure" setting.
Definition: ff_other.h:5234
bool GetIncludeInNumbering() const
Gets the state of the "Include in numbering" setting.
Definition: ff_other.h:5202
bool GetBreakMMRest() const
Gets the state of the "Break multi-measure rest" setting for a specific measure.
Definition: ff_other.h:4988
FCBeatChartElements * CreateBeatChartElements()
Creates a with the beat chart for the current measure.
Definition: finaleframework.cpp:5240
FCMeasure()
The constructor.
Definition: ff_other.h:4477
void SetTextFlag(bool state)
Sets the flag that marks if a measure contains any measure-attached text blocks.
Definition: ff_other.h:4616
bool Save() override
Overloaded version of Save(), that transfer key/time sig data to the measure info.
Definition: finaleframework.cpp:5178
void SetSpaceBefore(Evpu16 space)
Sets the extra space before the music in the measure.
Definition: ff_other.h:4701
void SetHideKeySigShowAccis(bool state)
Sets the "Hide key signature and show all accidentals" key signature state for the measure....
Definition: ff_other.h:4558
FCTimeSignature * GetTimeSignatureForDisplay() const
Returns a pointer to the time signature object. If time signature for display shouldn't be used,...
Definition: ff_other.h:5390
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:4453
void SetRepeatBracketFlag(bool state)
Sets if there are repeat brackets displayed for the measure.
Definition: ff_other.h:4645
bool GetKeyless() const
Returns the keyless time signature mode for the measure. Only works on Finale 2014 and above.
Definition: ff_other.h:4946
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:4454
SHOW_STATES GetShowTimeSignature() const
Gets the state for if the time signature should show or hide.
Definition: finaleframework.cpp:5452
void SetLeftBarline(BARLINE_STYLES style)
Sets the left barline style for the measure.
Definition: finaleframework.cpp:5377
BARLINE_STYLES GetLeftBarline() const
Gets the left barline style for the measure.
Definition: finaleframework.cpp:5523
TimeEdu32 GetDuration()
Returns the duration of the measure, based on the standard time signature.
Definition: ff_other.h:4935
void SetExpressionFlag(bool state)
Sets the flag that marks if a measure contains any expressions.
Definition: ff_other.h:4605
void SetHideCautionary(bool state)
Sets the "Hide cautionary key/clefs/time sigs" setting for the measure.
Definition: ff_other.h:4673
void SetPositioningNotesMode(POSITIONING_MODES mode)
Sets the note positioning mode for the measure.
Definition: finaleframework.cpp:5400
bool GetExpressionFlag() const
Gets the flag that marks if a measure contains any expressions.
Definition: ff_other.h:5014
FCExpressions * CreateExpressions()
Creates a with the expressions for the current measure.
Definition: finaleframework.cpp:5247
BARLINE_STYLES
Settings used for FCMeasure::SetBarline(), FCMeasure::SetLeftBarline(), FCMeasure::GetBarline() and F...
Definition: ff_other.h:4371
@ BARLINE_THICK
Definition: ff_other.h:4386
@ BARLINE_SHAPE
Definition: ff_other.h:4395
@ BARLINE_NORMAL
Definition: ff_other.h:4377
@ BARLINE_FINAL
Definition: ff_other.h:4389
@ BARLINE_DASHED
Definition: ff_other.h:4383
@ BARLINE_DOUBLE
Definition: ff_other.h:4380
@ BARLINE_DEFAULT
Definition: ff_other.h:4399
@ BARLINE_TICK
Definition: ff_other.h:4392
@ BARLINE_NONE
Definition: ff_other.h:4374
Evpu16 GetSpaceBefore() const
Gets the extra space before the music in the measure.
Definition: ff_other.h:5093
void SetIncludeInNumbering(bool state)
Sets the "Include in numbering" setting.
Definition: ff_other.h:4809
Evpu16 GetSpaceAfter() const
Gets the extra space after the music in the measure.
Definition: ff_other.h:5109
void SetBreakWordExtension(bool state)
Sets the "Break Word Extension" state.
Definition: ff_other.h:4801
void SetOverrideGroupBarlines(bool state)
Sets the "Override group barlines" setting.
Definition: ff_other.h:4817
bool GetShowFullNames() const
Gets the state of the "Show full staff & group name" setting.
Definition: finaleframework.cpp:5464
FCKeySignature * GetKeySignature() const
Returns a pointer to the key signature object.
Definition: ff_other.h:5310
void SetContainsManualMeasureNumbers(bool state)
Marks the measure that it contains manually adjusted measure numbers (or not).
Definition: ff_other.h:4793
bool GetBreakWordExtension() const
Gets the "Break Word Extension" state.
Definition: ff_other.h:5194
bool GetTextRepeatFlag() const
Returns true if there are text repeats in the measure.
Definition: ff_other.h:5060
bool GetBackwardRepeat() const
Returns true if the backward repeat should be displayed for the measure.
Definition: ff_other.h:5036
void SetShowKeySignature(SHOW_STATES state)
Sets the if the key signature should show or hide.
Definition: finaleframework.cpp:5261
void SetAllowHorizontalSplit(bool state)
Sets the "Allow Horizontal Split Points" setting.
Definition: ff_other.h:4741
void SetSpaceAfter(Evpu16 space)
Sets the extra space after the music in the measure.
Definition: ff_other.h:4719
CMPER GetBarlineShapeID() const
Returns the barline shape ID (for use with the FCShapeDef class), for custom barlines.
Definition: ff_other.h:5270
void SetBarline(FCMeasure::BARLINE_STYLES style)
Sets the barline style for the measure.
Definition: finaleframework.cpp:5360
void SetBarlineShapeID(twobyte shapeID)
Sets the barline shape ID (for use with the FCShapeDef class), for custom barlines.
Definition: ff_other.h:4865
Evpu16 GetWidth() const
Gets the (relative) measure width.
Definition: ff_other.h:5077
bool GetSmartShapeFlag() const
Returns true if a smart shape runs somewhere through the measure.
Definition: ff_other.h:5332
void SetShowFullNames(bool state)
Sets the "Show full staff & group name" setting.
Definition: finaleframework.cpp:5394
void SetPageBreak(bool state)
Sets the page break for a specific measure.
Definition: ff_other.h:4575
bool GetAllowHorizontalSplit() const
Gets the state of the "Allow Horizontal Split Points" setting.
Definition: ff_other.h:5127
POSITIONING_MODES
Settings used for FCMeasure::SetPositioningNotesMode() and FCMeasure::GetPositioningNotesMode()
Definition: ff_other.h:4423
@ POSITIONING_MANUALLY
Definition: ff_other.h:4429
@ POSITIONING_BEATCHART
Definition: ff_other.h:4432
@ POSITIONING_TIMESIG
Definition: ff_other.h:4426
bool GetUseTimeSigForDisplay() const
Returns if the measure should use another time sig for display.
Definition: ff_other.h:5166
bool GetChordFlag() const
Returns true if chords are available anywhere in the measure.
Definition: ff_other.h:5342
virtual ~FCMeasure()
Destructor.
Definition: ff_other.h:4488
FCString * CreateNumberStringUnqualified(bool showAllRepeatPasses=false)
Creates and returns a string containing the measure number string for this measure....
Definition: ff_other.h:5473
void SetShowTimeSignature(SHOW_STATES state)
Sets the if the time signature should show or hide.
Definition: finaleframework.cpp:5286
SHOW_STATES GetShowKeySignature() const
Sets the state for if the key signature should show or hide.
Definition: finaleframework.cpp:5435
bool GetHideCautionary() const
Gets the state of the "Hide cautionary key/clefs/time sigs" setting for the measure.
Definition: ff_other.h:5069
POSITIONING_MODES GetPositioningNotesMode() const
Gets the note positioning mode for the measure.
Definition: finaleframework.cpp:5475
FCMeasure::BARLINE_STYLES GetBarline() const
Gets the barline style for the measure.
Definition: finaleframework.cpp:5494
FCTimeSignature * GetTimeSignature() const
Returns a pointer to the time signature object.
Definition: ff_other.h:5358
void SetLeftBarlineShapeID(twobyte shapeID)
Sets the left barline shape ID (for use with the FCShapeDef class), for custom left barlines.
Definition: ff_other.h:4882
bool GetContainsManualMeasureNumbers() const
Gets the state that marks if the measure contains manually adjusted measure numbers (or not).
Definition: ff_other.h:5186
void SetPositionEvenly(bool state)
Sets the "Position Evenly across Measure" setting.
Definition: ff_other.h:4842
void SetBreakMMRest(bool state)
Sets the "Break multi-measure rest" setting for a specific measure.
Definition: ff_other.h:4585
CMPER GetLeftBarlineShapeID() const
Returns the left barline shape ID (for use with the FCShapeDef class), for custom left barlines.
Definition: ff_other.h:5286
bool GetTextFlag() const
Gets the flag that marks if a measure contains any measure-attached text blocks.
Definition: ff_other.h:5025
void SetSmartShapeFlag(bool state)
Set to true if a smart shape runs somewhere through the measure. Use with extreme care!
Definition: ff_other.h:4918
void SetUseTimeSigForDisplay(bool value)
Turns time sig for display ON or OFF.
Definition: ff_other.h:5421
void SetKeyless(bool state)
Sets the keyless time signature mode for the measure. Only works on Finale 2014 and above.
Definition: ff_other.h:4548
bool Load(CMPER itemno) override
Overloaded version of Load(), that removes any existing key/time sig data.
Definition: finaleframework.cpp:5228
bool GetPageBreak() const
Gets the page break state for a specific measure.
Definition: ff_other.h:4979
void SetBackwardRepeat(bool state)
Sets if a backward repeat should be displayed for the measure or not.
Definition: ff_other.h:4631
bool GetHideKeySigShowAccis() const
Returns the "Hide key signature and show all accidentals" key signature state for the measure....
Definition: ff_other.h:4960
FCTempoElements * CreateTempoElements()
Creates a with the Tempo Tool changes for the current measure.
Definition: finaleframework.cpp:5254
void SetSystemBreak(bool state)
Sets the measure to force a system break.
Definition: ff_other.h:4664
void SetTextRepeatFlag(bool state)
Sets the stat that marks if there are text repeats in the measure.
Definition: ff_other.h:4656
bool GetRepeatBracketFlag() const
Returns true if repeat brackets display for the measure.
Definition: ff_other.h:5049
FCString * CreateNumberString(bool showAllRepeatPasses=false)
Creates and returns a string containing the measure number string for this measure....
Definition: ff_other.h:5449
bool GetOverrideGroupBarlines() const
Gets the state of the "Override group barlines" setting.
Definition: ff_other.h:5210
bool GetForwardRepeat() const
Returns true if a forward repeat should be displayed for the measure.
Definition: ff_other.h:5004
void SetWidth(Evpu16 width)
Sets the (relative) measure width.
Definition: ff_other.h:4684
SHOW_STATES
Settings used for FCMeasure::SetShowKeySignature(), FCMeasure::SetShowTimeSignature(),...
Definition: ff_other.h:4441
@ SHOWSTATE_IFNEEDED
Definition: ff_other.h:4444
@ SHOWSTATE_HIDE
Definition: ff_other.h:4450
@ SHOWSTATE_SHOW
Definition: ff_other.h:4447
The class for a measure number region.
Definition: ff_other.h:5494
void SetUseEnclosureMultiple(bool use, bool parts)
Sets if enclosures should be used for multiple numbers.
Definition: finaleframework.cpp:6483
void SetDoubleUp(bool value)
Sets if the double-up (=duplicating the first character) style should be used or not.
Definition: finaleframework.cpp:7086
void SetHideFirstNumber(bool hide, bool parts)
Sets if the first occurence should be hidden or not.
Definition: finaleframework.cpp:6543
bool GetUseEnclosureStart(bool parts)
Returns true if start measure numbers should use the enclosure data.
Definition: finaleframework.cpp:7281
void SetShowOnTopStaff(bool showontop, bool parts)
Sets if the measure number should be shown on top staff or not.
Definition: finaleframework.cpp:6495
void SetStartMeasure(twobyte measure)
Sets the start measure for the measure number region.
Definition: finaleframework.cpp:6352
void SetUseScoreInfoForParts(bool value)
Sets if parts should use the score information section of the measure number region appearance.
Definition: finaleframework.cpp:6412
twobyte GetMultipleVerticalPosition(bool parts)
Returns the default vertical position for the multiple numbers.
Definition: finaleframework.cpp:7587
void SetID(twobyte newid)
Sets the unique measure number region ID. USE WITH CARE!!!
Definition: finaleframework.cpp:6419
void CloneFormattingFrom(FCMeasureNumberRegion *pRegionFrom, bool score, bool parts)
Copies the formatting part (visual appearance + positioning) of the measure number region.
Definition: finaleframework.cpp:7665
MNALIGNMENTS GetMultipleAlignment(bool parts)
Returns the alignment for "multiple" measure numbers.
Definition: finaleframework.cpp:7483
FCEnclosure * GetEnclosureMultiple(bool parts)
Gets the pointer to the multiple enclosure object. This object is a part of the measure number region...
Definition: ff_other.h:6482
MNALIGNMENTS
The measure number alignment values.
Definition: ff_other.h:5724
@ MNALIGN_CENTER
Definition: ff_other.h:5729
@ MNALIGN_RIGHT
Definition: ff_other.h:5732
@ MNALIGN_LEFT
Definition: ff_other.h:5726
MNJUSTIFICATIONS GetMultipleJustification(bool parts)
Returns the justifications for "multiple" measure numbers.
Definition: finaleframework.cpp:7506
bool GetShowOnTopStaff(bool parts)
Returns true if top staff should show a measure number.
Definition: finaleframework.cpp:7311
void SetBase(twobyte base)
Sets the base for the measure numbering style.
Definition: finaleframework.cpp:7029
FCString * CreateDisplayedString(twobyte measure)
Creates a string with the measure number as it would be displayed for the measure.
Definition: finaleframework.cpp:7651
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:5751
void SetShowMultiples(bool showmultiples, bool parts)
Sets if the "multiple" numbering should be used or not.
Definition: finaleframework.cpp:6531
bool GetNoZero() const
Returns if no zero should be used.
Definition: finaleframework.cpp:7113
void SetTimeFrames(bool state)
Returns true if "frames" for time measure numbers.
Definition: finaleframework.cpp:7054
void SetMultipleHorizontalPosition(twobyte distance, bool parts)
Sets the horizontal position of multiple numbers.
Definition: finaleframework.cpp:6815
void SetUseEnclosureStart(bool use, bool parts)
Sets if enclosures should be used for start numbers.
Definition: finaleframework.cpp:6467
bool GetUseEnclosureMultiple(bool parts)
Returns true if "multiple" measure numbers should use the enclosure data.
Definition: finaleframework.cpp:7299
void GetStartFontInfo(FCFontInfo *pFontInfo, bool parts)
Gets the start font for the measure number region.
Definition: finaleframework.cpp:7608
bool GetShowMultiMeasureRange(bool parts)
Returns true if the measure range should be displayed for multimeasure rests.
Definition: finaleframework.cpp:7371
void SetUseHours(bool state)
Returns if time measure numbers should include hours.
Definition: finaleframework.cpp:7060
bool GetShowMultiples(bool parts)
Returns true if repeated numbered sequences are used.
Definition: finaleframework.cpp:7347
NUMBERVIEWS GetView() const
Returns the view where the number region should show.
Definition: finaleframework.cpp:6954
void SetStartNumber(twobyte offset)
Sets the start measure for the measure number region.
Definition: finaleframework.cpp:6362
void SetPrefix(FCString *pString)
Sets the prefix string.
Definition: finaleframework.cpp:6367
void SetExcludeOtherStaves(bool exclude, bool parts)
Sets if the numbers should be excluded on other staves.
Definition: finaleframework.cpp:6475
void SetTime(bool state)
Sets if a time mode is used.
Definition: finaleframework.cpp:7048
void SetTimePrecision(twobyte precision)
Sets the time precision, for the time modes that aren't based on frames.
Definition: finaleframework.cpp:7066
eUniChar32 GetMultiMeasureBracketLeft(bool parts)
Returns the left-side range bracket character for multimeasure rest ranges.
Definition: finaleframework.cpp:7391
bool GetBreakMultiMeasureRests(bool parts)
Returns true if multiple measure numbers should break multi-measure rests.
Definition: finaleframework.cpp:7421
void GetPrefix(FCString *pString)
Copies the prefix string to a FCString object.
Definition: finaleframework.cpp:7252
bool GetHideFirstNumber(bool parts)
Returns true if the first number in the measure number region should be hidden.
Definition: finaleframework.cpp:7359
twobyte GetMultiMeasureVerticalPosition(bool parts)
Returns the vertical position of for multimeasure rests.
Definition: finaleframework.cpp:7601
void SetMultipleFontInfo(FCFontInfo *pFontInfo, bool parts)
Sets the multiple font for the measure number region.
Definition: finaleframework.cpp:6437
void _SetTempNonIncludedMeasures(FCNumbers *pNonNumberedMeasuresToUse)
For internal use only.
Definition: ff_other.h:6915
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:6934
void SetShowOnSystemStart(bool showonstart, bool parts)
Sets if the measure number should be shown on system starts or not.
Definition: finaleframework.cpp:6507
void SetShowOnMultiMeasureRests(bool show, bool parts)
Sets if the measure numbers should show on multimeasure rests.
Definition: finaleframework.cpp:6560
void SetView(NUMBERVIEWS view)
Sets the view where the region should show.
Definition: finaleframework.cpp:6844
MNALIGNMENTS GetStartAlignment(bool parts)
Returns the alignment for start measure numbers.
Definition: finaleframework.cpp:7437
bool AssignAllNonNumberedMeasures(FCNumbers *pAllNonNumberedMeasures)
Assigns a reference table for all non-numbered measures in the document.
Definition: finaleframework.cpp:7726
FCFontInfo * CreateMultiMeasureFontInfo(bool parts)
Creates a FCFontInfo object with the font information about the multimeasure rest measure numbers.
Definition: ff_other.h:6825
bool IsMeasureIncluded(twobyte measureno)
Returns true if the measure is within the measure number region.
Definition: ff_other.h:6879
bool GetDoubleUp() const
Returns true if the numbering model is a "double up" (a, b, c, .... aa, bb, cc, etc)
Definition: finaleframework.cpp:7144
void SetNumberingStyle(NUMBERINGSTYLE style)
Sets the numbering style.
Definition: finaleframework.cpp:6873
void GetMultiMeasureFontInfo(FCFontInfo *pFontInfo, bool parts)
Gets the font to be used for multi-measure rests.
Definition: finaleframework.cpp:7636
twobyte GetStartMeasure() const
Returns the start measure of the measure number region.
Definition: finaleframework.cpp:7098
void SetStartAlignment(MNALIGNMENTS alignment, bool parts)
Sets the alignment for start measure numbers.
Definition: finaleframework.cpp:6620
void SetStartFontInfo(FCFontInfo *pFontInfo, bool parts)
Sets the start font for the measure number region.
Definition: finaleframework.cpp:6424
void SetMultiMeasureBracketLeft(eUniChar32 character, bool parts)
Sets the left-side range bracket character for multimeasure rest ranges.
Definition: finaleframework.cpp:6578
twobyte GetStartNumber() const
Returns the measure region's starting number (for display).
Definition: finaleframework.cpp:7108
void GetMultipleFontInfo(FCFontInfo *pFontInfo, bool parts)
Gets the multiple font for the measure number region.
Definition: finaleframework.cpp:7621
bool GetShowOnBottomStaff(bool parts)
Returns true if bottom staff should show a measure number.
Definition: finaleframework.cpp:7335
bool GetDisplayedNumber(eMeas number, FCString *pString)
Formats the displayed number for a measure (without prefix/suffix)
Definition: finaleframework.cpp:7214
void SetStartJustification(MNJUSTIFICATIONS justification, bool parts)
Sets the justification for the start measure numbers.
Definition: finaleframework.cpp:6650
MNJUSTIFICATIONS GetMultiMeasureJustification(bool parts)
Returns the justifications for multimeasure rest measure numbers.
Definition: finaleframework.cpp:7552
twobyte GetMultipleValue(bool parts)
Returns the "Show on every" value for multiple measure numbers.
Definition: finaleframework.cpp:7381
void SetStartVerticalPosition(twobyte distance, bool parts)
Sets the default vertical position of start numbers.
Definition: finaleframework.cpp:6810
twobyte GetMultiMeasureHorizontalPosition(bool parts)
Returns the horizontal position of for multimeasure rests.
Definition: finaleframework.cpp:7594
MNJUSTIFICATIONS
The measure number justification values.
Definition: ff_other.h:5740
@ MNJUSTIFY_LEFT
Definition: ff_other.h:5742
@ MNJUSTIFY_RIGHT
Definition: ff_other.h:5748
@ MNJUSTIFY_CENTER
Definition: ff_other.h:5745
twobyte GetMultipleStartMeasure(bool parts)
Returns the "Show on every" value for multiple measure numbers.
Definition: finaleframework.cpp:7386
void SetCountFromOne(bool value)
Sets if the measuring should start from one instead of zero.
Definition: finaleframework.cpp:7074
void SetMultipleAlignment(MNALIGNMENTS alignment, bool parts)
Sets the alignment for "multiple" measure numbers.
Definition: finaleframework.cpp:6683
void SetMultiMeasureAlignment(MNALIGNMENTS alignment, bool parts)
Sets the alignment for multimeasure measure numbers.
Definition: finaleframework.cpp:6744
void SetMultiMeasureHorizontalPosition(twobyte distance, bool parts)
Sets the horizontal position of multimeasure rest numbers.
Definition: finaleframework.cpp:6829
void SetMultiMeasureJustification(MNJUSTIFICATIONS justification, bool parts)
Sets the justification for the start measure numbers.
Definition: finaleframework.cpp:6774
void SetMultipleValue(twobyte value, bool parts)
Sets the "Show on every" value for multiple measure numbers.
Definition: finaleframework.cpp:6565
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:5752
eUniChar32 GetStartCharacter() const
Gets the base character.
Definition: finaleframework.cpp:7158
bool GetTime() const
Returns true if a time mode is used.
Definition: finaleframework.cpp:7119
void SetBreakMultiMeasureRests(bool breakstate, bool parts)
Sets if "multiple" measure numbers should break multimeasure rests or not.
Definition: finaleframework.cpp:6610
void _RestoreTempNonIncludedMeasures()
For internal use only.
Definition: ff_other.h:6927
twobyte GetID()
Returns the unique measure number region ID.
Definition: finaleframework.cpp:7093
void SetMultipleVerticalPosition(twobyte distance, bool parts)
Sets the vertical position of multiple numbers.
Definition: finaleframework.cpp:6822
bool GetTimeFrames() const
Returns true if "frames" for time measure numbers.
Definition: finaleframework.cpp:7125
twobyte GetBase() const
Returns the number base.
Definition: finaleframework.cpp:7168
MNALIGNMENTS GetMultiMeasureAlignment(bool parts)
Returns the alignment for multimeasure rest measure numbers.
Definition: finaleframework.cpp:7529
void SetMultiMeasureVerticalPosition(twobyte distance, bool parts)
Sets the vertical position of multimeasure rest numbers.
Definition: finaleframework.cpp:6836
NUMBERVIEWS
The number views where the region should show.
Definition: ff_other.h:5708
@ NUMBERVIEW_ALL
Definition: ff_other.h:5710
@ NUMBERVIEW_SCROLLONLY
Definition: ff_other.h:5716
@ NUMBERVIEW_PAGEONLY
Definition: ff_other.h:5713
twobyte GetStartHorizontalPosition(bool parts)
Returns the default horizontal position for start numbers.
Definition: finaleframework.cpp:7570
void SetMultipleJustification(MNJUSTIFICATIONS justification, bool parts)
Sets the justification for the "multiple" measure numbers.
Definition: finaleframework.cpp:6713
twobyte GetStartVerticalPosition(bool parts)
Returns the default vertical position for start numbers.
Definition: finaleframework.cpp:7575
FCMeasureNumberRegion()
The constructor.
Definition: finaleframework.cpp:5555
bool GetExcludeOtherStaves(bool parts)
Returns true if measure numbers should be excluded on other staves.
Definition: finaleframework.cpp:7290
void SetMultiMeasureBracketRight(eUniChar32 character, bool parts)
Sets the right-side range bracket character for multimeasure rest ranges.
Definition: finaleframework.cpp:6594
bool GetShowOnSystemStart(bool parts)
Returns true if the system start should show a measure number.
Definition: finaleframework.cpp:7323
bool GetCountFromOne() const
Returns true if the numbering model starts with 1 (numbers) or 0 (letters).
Definition: finaleframework.cpp:7151
void SetStartCharacter(eUniChar32 character)
Sets the starting character of the measure numbering style.
Definition: finaleframework.cpp:7034
FCFontInfo * CreateStartFontInfo(bool parts)
Creates a FCFontInfo object with the font information about the start measure numbers.
Definition: ff_other.h:6749
void GetSuffix(FCString *pString)
Gets the suffix string.
Definition: finaleframework.cpp:7266
void SetEndMeasure(twobyte measure)
Sets the end measure for the measure number region.
Definition: finaleframework.cpp:6357
eUniChar32 GetMultiMeasureBracketRight(bool parts)
Returns the right-side range bracket character for multimeasure rest ranges.
Definition: finaleframework.cpp:7406
twobyte GetTimePrecision() const
Returns the time precision, for the time modes that aren't based on frames.
Definition: finaleframework.cpp:7137
NUMBERINGSTYLE GetNumberingStyle() const
Returns the numbering style.
Definition: finaleframework.cpp:6971
bool GetUseHours() const
Returns if time measure numbers should include hours.
Definition: finaleframework.cpp:7131
FCFontInfo * CreateMultipleFontInfo(bool parts)
Creates a FCFontInfo object with the font information about the "multiple" measure numbers.
Definition: ff_other.h:6787
NUMBERINGSTYLE
Numbering styles for measure numbers.
Definition: ff_other.h:5668
@ NUMBERING_FRAMES
Definition: ff_other.h:5697
@ NUMBERING_TIME_1000
Definition: ff_other.h:5694
@ NUMBERING_UPPERCASEDOUBLE
Definition: ff_other.h:5676
@ NUMBERING_CUSTOM
Definition: ff_other.h:5700
@ NUMBERING_DIGITS
Definition: ff_other.h:5670
@ NUMBERING_TIME_10
Definition: ff_other.h:5688
@ NUMBERING_TIME_100
Definition: ff_other.h:5691
@ NUMBERING_TIME_SECONDS
Definition: ff_other.h:5685
@ NUMBERING_LOWERCASEDOUBLE
Definition: ff_other.h:5673
@ NUMBERING_LOWERCASE
Definition: ff_other.h:5679
@ NUMBERING_UPPERCASE
Definition: ff_other.h:5682
twobyte GetMultipleHorizontalPosition(bool parts)
Returns the default horizontal position for the multiple numbers.
Definition: finaleframework.cpp:7580
void SetNoZero(bool value)
Sets if no zero should be used.
Definition: finaleframework.cpp:7080
void SetSuffix(FCString *pString)
Sets the suffix string.
Definition: finaleframework.cpp:6391
twobyte GetEndMeasure() const
Returns the end measure of the measure number region.
Definition: finaleframework.cpp:7103
bool GetUseScoreInfoForParts() const
Returns true if parts should use the score information section of the measure number region appearanc...
Definition: finaleframework.cpp:7173
bool GetDisplayedNumberWithID(eMeas number, FCString *pString)
Formats the displayed number for a measure, with the region ID.
Definition: finaleframework.cpp:7241
void SetMultipleStartMeasure(twobyte measure, bool parts)
Sets the "Show on every" start value for multiple measure numbers.
Definition: finaleframework.cpp:6570
void SetStartHorizontalPosition(twobyte distance, bool parts)
Sets the default horizontal position of start numbers.
Definition: finaleframework.cpp:6805
void SetShowMultiMeasureRange(bool show, bool parts)
Sets if the measure range should be displayed for multimeasure rests or not.
Definition: finaleframework.cpp:6555
MNJUSTIFICATIONS GetStartJustification(bool parts)
Returns the justifications for start measure numbers.
Definition: finaleframework.cpp:7460
void SetShowOnBottomStaff(bool showonbottom, bool parts)
Sets if the measure number should be displayed on the bottom staff or not.
Definition: finaleframework.cpp:6519
FCEnclosure * GetEnclosureStart(bool parts)
Gets the pointer to the start enclosure object. This object is a part of the measure number region an...
Definition: ff_other.h:6468
bool GetShowOnMultiMeasureRests(bool parts)
Returns true if the measure numbers should show on multimeasure rests.
Definition: finaleframework.cpp:7376
void SetMultiMeasureFontInfo(FCFontInfo *pFontInfo, bool parts)
Sets the font to be used for multi-measure rests.
Definition: finaleframework.cpp:6452
Collection class for FCMeasure class objects.
Definition: ff_othercollection.h:228
Class for a multi-measure rest instance.
Definition: ff_other.h:19613
void SetNumberHorizontalAdjust(twobyte value)
Sets the horizontal adjustment value for the multimeasure rest number.
Definition: ff_other.h:19873
twobyte GetShapeStartAdjust() const
Returns the left-side adjustment for multimeasure shapes.
Definition: ff_other.h:19746
twobyte GetUseSymbolsLessThan() const
Returns the number of measures for the "Use symbols for rests less than" option.
Definition: ff_other.h:19721
bool IsMeasureIncluded(int measure)
Returns true if the measure number is included in the MM rest.
Definition: ff_other.h:19885
void PrefsReset()
Resets the object to the current default values.
Definition: finaleframework.cpp:12163
void SetEndMeasure(twobyte measure)
Sets the end measure of the MM rest.
Definition: ff_other.h:19802
void SetShapeEndAdjust(twobyte value)
Sets the right-side adjustment for MM shapes.
Definition: ff_other.h:19809
FCMultiMeasureRest()
The constructor.
Definition: ff_other.h:19668
void SetStretchHorizontally(bool value)
Sets if shape should be stretched horizontally for the MM rest.
Definition: finaleframework.cpp:12178
bool GetStretchHorizontally() const
Returns if shape should be stretched horizontally for the MM rest.
Definition: finaleframework.cpp:12171
void SetUseSymbols(bool value)
Sets if the "Use symbols for rests less than" is used.
Definition: ff_other.h:19832
twobyte GetStartNumberingAt() const
Returns the threshold number where mm rests should start to be created.
Definition: ff_other.h:19761
void SetShapeStartAdjust(twobyte value)
Sets the left-side adjustment for MM shapes.
Definition: ff_other.h:19816
twobyte GetShapeID() const
Returns the shape ID (for use in the FCShapeDef class) for the MM rest.
Definition: ff_other.h:19703
twobyte GetEndMeasure() const
Returns the end measure of the MM rest.
Definition: ff_other.h:19688
twobyte GetShapeEndAdjust() const
Returns the right-side adjustment for multimeasure shapes.
Definition: ff_other.h:19739
void SetNumberVerticalAdjust(twobyte value)
Sets the vertical adjustment value for the multimeasure rest number.
Definition: ff_other.h:19879
twobyte GetNumberVerticalAdjust() const
Returns the vertical adjustment value for the multimeasure rest number.
Definition: ff_other.h:19774
twobyte GetSymbolSpace() const
Gets the space between multimeasure rest symbols for the mm rest.
Definition: ff_other.h:19753
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:19651
void SetSymbolSpace(twobyte space)
Sets the space between multimeasure rest symbols.
Definition: ff_other.h:19861
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:19650
void SetShapeID(twobyte shapeID)
Sets the shape ID (for use in the FCShapeDef class) for the MM rest.
Definition: ff_other.h:19824
bool GetUseSymbols() const
Returns true if the "Use symbols for rests less than" is used.
Definition: ff_other.h:19710
twobyte GetWidth() const
Returns the width of the MM rest.
Definition: ff_other.h:19695
void SetUseSymbolsLessThan(twobyte value)
Sets the number of measures for the "Use symbols for rests less than" option.
Definition: ff_other.h:19843
bool IsShape()
Returns true if a shape is used for the MM rest.
Definition: ff_other.h:19896
twobyte GetNumberHorizontalAdjust() const
Returns the horizontal adjustment value for the multimeasure rest number.
Definition: ff_other.h:19768
void SetStartNumberingAt(twobyte value)
Sets the threshold number where mm rests should start to be created.
Definition: ff_other.h:19867
void SetWidth(twobyte value)
Sets the width of the MM rest.
Definition: ff_other.h:19786
twobyte CalcMeasureSpan()
Calculates the number of measures that MM rest spans.
Definition: ff_other.h:19780
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:19915
twobyte GetStartMeasure() const
Returns the start measure of the MM rest.
Definition: ff_other.h:19681
void SetStartMeasure(twobyte measure)
Sets the start measure of the MM rest.
Definition: ff_other.h:19795
Class for a multi-staff instrument defined in the Score Manager.
Definition: ff_other.h:19933
CMPER CalcTopStaff()
Returns the top staff in the group.
Definition: ff_other.h:20069
CMPER CalcBottomStaff()
Returns the bottom staff in the group.
Definition: ff_other.h:20099
void SetFirstStaff(CMPER value)
Sets the staff number of the first staff in the instrument group, Use with care!
Definition: ff_other.h:20038
CMPER GetSecondStaff() const
Returns the staff number of the second staff in the instrument group.
Definition: ff_other.h:20015
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:20125
void SetSecondStaff(CMPER value)
Sets the staff number of the second staff in the instrument group. Use with care!
Definition: ff_other.h:20044
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:19969
void SetThirdStaff(CMPER value)
Sets the staff number of the third staff in the instrument group.
Definition: ff_other.h:20051
CMPER GetThirdStaff() const
Returns the staff number of the third staff in the instrument group.
Definition: ff_other.h:20021
bool ContainsStaff(CMPER staffno)
Returns true if the staff is available in the multi-instrument group.
Definition: ff_other.h:19996
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:19968
eStaffGroup GetGroupID() const
Returns the staff group ID.
Definition: ff_other.h:20027
CMPER GetFirstStaff() const
Returns the staff number of the first staff in the instrument group.
Definition: ff_other.h:20009
void SetGroupID(eStaffGroup value)
Sets the staff group ID. Use with care!
Definition: ff_other.h:20057
FCMultiStaffInstrument()
The constructor.
Definition: ff_other.h:19986
Class that encapsulates EREGION and provides additional functionality to region handling.
Definition: ff_region.h:25
twobyte GetStartMeasure() const
Returns the start measure for the region.
Definition: ff_region.h:411
TimeEdu32 GetStartMeasurePos() const
Returns the start position of the region within the measure.
Definition: ff_region.h:489
bool IsStaffIncluded(twobyte staffnumber) const
Returns true if the staff number is with the region.
Definition: finaleframework.cpp:15679
twobyte GetEndMeasure() const
Returns the end measure for the region.
Definition: ff_region.h:419
TimeEdu32 GetEndMeasurePos() const
Returns the end position of the region within the measure.
Definition: ff_region.h:499
Encapsulates a note entry from an owner class (for example FCNoteEntryCell, FCNoteEntryLayer) class.
Definition: ff_noteframe.h:940
Simple class to put numbers into collections.
Definition: ff_base.h:4790
int GetInt() const
Returns the integer value version of the number.
Definition: ff_base.h:4834
Simple collection class for FCNumber class objects.
Definition: ff_basecollection.h:357
FCNumber * GetItemAt(int index) const
Overridden GetItemAt method.
Definition: ff_basecollection.h:404
Utility class to provide a mechanism for loading blob data blocks consisting of more than 1 inci....
Definition: ff_other.h:167
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:214
FCOtherInci(EXTAG customTag=0)
the constructor
Definition: ff_other.h:195
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:215
Class for page-assigned graphics. Currently, this class can only be used to edit existing page graphi...
Definition: ff_other.h:20251
void SetVerticalAlignment(GRAPHIC_VERTICAL_ALIGN alignment)
Sets the vertical alignment for the text block.
Definition: ff_other.h:20733
bool IsEmbedded()
Returns true if the graphic is embedded in the document.
Definition: ff_other.h:20352
void SetLastPage(int pageno)
Sets the end page for the graphics.
Definition: ff_other.h:20540
GRAPHIC_HORIZONTAL_ALIGN GetHorizontalAlignment() const
Returns the horizontal alignment for the graphic on left-side (or all) pages.
Definition: ff_other.h:20482
GRAPHIC_VERTICAL_ALIGN GetVerticalAlignment() const
Returns the vertical alignment for the graphic.
Definition: ff_other.h:20518
void SetIndependentRightPage(bool state)
Sets if the right-side page positioning is used or not.
Definition: ff_other.h:20619
Evpu16 GetWidth() const
Returns the graphic rectangle's width, in EVPUs.
Definition: ff_other.h:20397
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:20295
void SetVerticalPos(Evpu16 pos)
Sets the graphic rectangle's bottom position, in EVPUs.
Definition: ff_other.h:20565
GRAPHIC_HORIZONTAL_ALIGN GetHorizontalAlignmentRightPage() const
Returns the horizontal alignment for a right-side page graphic.
Definition: ff_other.h:20500
void SetHorizontalPosRightPage(Evpu16 value)
Sets the horizontal position for right-side pages (if used).
Definition: ff_other.h:20633
void SetHorizontalAlignmentRightPage(GRAPHIC_HORIZONTAL_ALIGN alignment)
Sets the horizontal alignment for right-side pages.
Definition: ff_other.h:20699
Evpu16 GetVerticalPosRightPage() const
Returns the vertical positioning for right-side pages (if used).
Definition: ff_other.h:20461
void SetVisible(bool state)
Sets the visibility state of the graphic.
Definition: ff_other.h:20593
FCPageGraphic()
The constructor.
Definition: ff_other.h:20343
bool GetPageEdgeRef() const
Returns true if positioning is referenced from the page edge.
Definition: ff_other.h:20443
Evpu16 GetOriginalHeight() const
Returns the original graphic rectangle's height (before stretching), in EVPUs.
Definition: ff_other.h:20424
void SetVerticalPosRightPage(Evpu16 value)
Sets the vertical position for right-side pages (if used).
Definition: ff_other.h:20642
Evpu16 GetHorizontalPosRightPage() const
Returns the horizontal positioning for right-side pages (if used).
Definition: ff_other.h:20455
int GetFirstPage() const
Returns the start page for the graphics.
Definition: ff_other.h:20361
void SetFirstPage(int pageno)
Sets the start page for the graphics.
Definition: ff_other.h:20531
GRAPHIC_VERTICAL_ALIGN
Vertical alignment constants for graphic.
Definition: ff_other.h:20328
@ GRAPHICVERTALIGN_CENTER
Definition: ff_other.h:20334
@ GRAPHICVERTALIGN_TOP
Definition: ff_other.h:20330
@ GRAPHICVERTALIGN_BOTTOM
Definition: ff_other.h:20332
void SetHorizontalPos(Evpu16 pos)
Sets the graphic rectangle's left-side position, in EVPUs.
Definition: ff_other.h:20552
Evpu16 GetHorizontalPos() const
Returns the graphic rectangle's left-side position, in EVPUs.
Definition: ff_other.h:20379
void SetHeight(Evpu16 height)
Sets the graphic rectangle's height, in EVPUs.
Definition: ff_other.h:20584
GRAPHIC_HORIZONTAL_ALIGN
Horizontal alignment constants for graphic.
Definition: ff_other.h:20314
@ GRAPHICHORIZALIGN_LEFT
Definition: ff_other.h:20316
@ GRAPHICHORIZALIGN_RIGHT
Definition: ff_other.h:20318
@ GRAPHICHORIZALIGN_CENTER
Definition: ff_other.h:20320
void SetFixedPercent(bool state)
Sets the state of the "Fixed Percent" checkbox in the graphic attributes dialog box.
Definition: ff_other.h:20652
bool GetVisible() const
Returns the visibility status of the page graphic.
Definition: ff_other.h:20435
Evpu16 GetOriginalWidth() const
Returns the original graphic rectangle's width (before stretching), in EVPUs.
Definition: ff_other.h:20415
int GetLastPage() const
Returns the start page for the graphics.
Definition: ff_other.h:20370
bool GetFixedPercent() const
Returns the state of the "Fixed Percent" checkbox in the graphic attributes dialog box.
Definition: ff_other.h:20468
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:20296
void SetPageEdgeRef(bool state)
Sets if positioning is referenced from the page edge, or from the margin.
Definition: ff_other.h:20609
Evpu16 GetVerticalPos() const
Returns the graphic rectangle's bottom position, in EVPUs.
Definition: ff_other.h:20388
Evpu16 GetHeight() const
Returns the graphic rectangle's height, in EVPUs.
Definition: ff_other.h:20406
void SetWidth(Evpu16 width)
Sets the graphic rectangle's width, in EVPUs.
Definition: ff_other.h:20575
bool GetIndependentRightPage() const
Returns true if the right-side page positioning is used.
Definition: ff_other.h:20449
void SetHorizontalAlignment(GRAPHIC_HORIZONTAL_ALIGN alignment)
Sets the horizontal alignment for left-side (or all) pages.
Definition: ff_other.h:20663
The class representing a physical page in Finale.
Definition: ff_other.h:3398
eMeas CalcLastMeasure()
Calculates the last measure number on the page.
Definition: finaleframework.cpp:4934
void SetFirstSystem(eSsys firstsysno)
Sets the system number of the first system of the page.
Definition: finaleframework.cpp:4893
int CalcInteriorHeight(bool resize)
Returns the available space between the top and bottom margins on the page.
Definition: finaleframework.cpp:4941
void SetBottomMargin(Evpu16 margin)
Sets the bottom page margin, as a positive value.
Definition: ff_other.h:3610
FCPage()
The constructor.
Definition: ff_other.h:3440
void SetHoldMargins(bool state)
Sets the Hold Margins setting.
Definition: ff_other.h:3635
void SetWidth(Evpu32 width)
Sets the page width.
Definition: ff_other.h:3570
bool IsBlank() const
Returns true if this is a blank page.
Definition: ff_other.h:3482
void SetTopMargin(Evpu16 margin)
Sets the top page margin as a positive value.
Definition: ff_other.h:3602
Evpu16 GetRightMargin() const
Returns the right page margin as a positive value.
Definition: ff_other.h:3517
eSsys GetFirstSystem()
Gets the system number of the first system of the page.
Definition: finaleframework.cpp:4888
Evpu32 GetWidth() const
Returns the page width.
Definition: ff_other.h:3493
Evpu16 GetLeftMargin() const
Returns the left page margin as a positive value.
Definition: ff_other.h:3509
twobyte GetPercent() const
Returns the resize percentage of the page.
Definition: ff_other.h:3544
bool GetHoldMargins() const
Returns the status of the Hold Margins setting.
Definition: ff_other.h:3558
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:3422
Evpu16 GetBottomMargin() const
Returns the bottom page margin as a positive value.
Definition: ff_other.h:3533
void SetHeight(Evpu32 height)
Sets the page height.
Definition: ff_other.h:3578
void SetPercent(twobyte percent)
Set the resize percentage of the page.
Definition: ff_other.h:3621
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:3687
void UpdateLayout(bool bUnfreezeMeasures=false)
Updates the layout starting from the page and reloads the page data.
Definition: finaleframework.cpp:4898
bool IsPortrait() const
Returns true if the height is larger than the width.
Definition: ff_other.h:3473
Evpu16 GetTopMargin() const
Returns the top page margin as a positive value.
Definition: ff_other.h:3525
eSsys CalcLastSystem()
Calculates the last system on the page.
Definition: finaleframework.cpp:4904
Evpu32 GetHeight() const
Returns the page height.
Definition: ff_other.h:3501
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:3423
void SetLeftMargin(Evpu16 margin)
Sets the left page margin, as a positive value.
Definition: ff_other.h:3586
eMeas CalcFirstMeasure()
Calculates the first measure number on the page.
Definition: finaleframework.cpp:4927
void SetRightMargin(Evpu16 margin)
Sets the right page margin, as a positive value.
Definition: ff_other.h:3594
Class for a page-connected text block.
Definition: ff_other.h:16687
twobyte GetHorizontalPosRightPage() const
Returns the horizontal position for the text block on right-side pages (if used).
Definition: ff_other.h:16950
bool GetVisible() const
Returns true if the text block is visible (in the score/part that's currently in focus).
Definition: ff_other.h:16978
void SetHorizontalAlignment(TEXT_HORIZONTAL_ALIGN alignment)
Sets the horizontal alignment for left-side (or all) pages.
Definition: ff_other.h:17044
void SetFrameEdgeRef(bool state)
Sets if the frame edge of the text block is used as the positioning reference.
Definition: ff_other.h:17222
bool SaveNewTextBlock(FCString *pString)
Saves a new raw text block (both a raw text and the connected text block) and assigns it to the page ...
Definition: finaleframework.cpp:11813
bool GetPageEdgeRef() const
Returns true if positioning is referenced from the page edge.
Definition: ff_other.h:16918
FCPageText()
The constructor.
Definition: ff_other.h:16784
void SetVerticalPos(twobyte value)
Sets the vertical position for the text block. Smaller values go downward, higher values go upward.
Definition: ff_other.h:17165
FCString * CreateTextString()
Gets a pointer to the text string, as a string object.
Definition: ff_other.h:16799
bool GetFrameEdgeRef() const
Returns if the frame edge is used as the positioning reference or not.
Definition: ff_other.h:16929
bool SaveTextString(FCString *pString)
Resaves a raw text string. This method requires that the text block already exists.
Definition: finaleframework.cpp:11828
twobyte GetHorizontalPos() const
Returns the horizontal position for the text block.
Definition: ff_other.h:16941
void SetLastPage(ePage page)
Sets the page number for the last page. If a text block page only should appear on one page,...
Definition: ff_other.h:17130
void SetHorizontalAlignmentRightPage(TEXT_HORIZONTAL_ALIGN alignment)
Sets the horizontal alignment for right-side pages.
Definition: ff_other.h:17064
void SetVerticalAlignment(TEXT_VERTICAL_ALIGN alignment)
Sets the vertical alignment for the text block.
Definition: ff_other.h:17081
CMPER GetStringID() const
Returns the raw text ID for the page text (as an Engima string). This ID is "owned" by the connected ...
Definition: finaleframework.cpp:11793
twobyte GetLastPage() const
Returns the page number for the last page.
Definition: ff_other.h:16845
TEXT_HORIZONTAL_ALIGN GetHorizontalAlignmentRightPage() const
Returns the horizontal alignment for a right-side page text block.
Definition: ff_other.h:16892
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:16768
FCTextBlock * CreateTextBlock()
Creates a FCTextBlock object that belongs to the page text. (It might return NULL....
Definition: finaleframework.cpp:11801
TEXT_ASSIGNMENT
Constants for how text blocks are displayed.
Definition: ff_other.h:16758
@ TEXTASSIGN_ALL
Definition: ff_other.h:16760
@ TEXTASSIGN_ODD
Definition: ff_other.h:16762
@ TEXTASSIGN_EVEN
Definition: ff_other.h:16764
CMPER GetTextBlockID() const
Returns the connected block ID for the text. For use with FCTextBlock.
Definition: ff_other.h:16997
twobyte GetFirstPage() const
Returns the page number for the first page.
Definition: ff_other.h:16834
void SetHorizontalPosRightPage(twobyte value)
Sets the horizontal position for the text block on right-side pages.
Definition: ff_other.h:17152
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:17240
twobyte GetVerticalPosRightPage() const
Returns the vertical position for the text block for right-side pages (if used).
Definition: ff_other.h:16968
TEXT_VERTICAL_ALIGN
Vertical alignment constants for text blocks.
Definition: ff_other.h:16744
@ TEXTVERTALIGN_TOP
Definition: ff_other.h:16746
@ TEXTVERTALIGN_BOTTOM
Definition: ff_other.h:16748
@ TEXTVERTALIGN_CENTER
Definition: ff_other.h:16750
void SetVisible(bool visible)
Sets if the text block should be visible or not (in the score/part that's currently in focus - works ...
Definition: ff_other.h:17185
void _SetTextBlockID(CMPER textblockid)
Sets the connected block ID for the text. For use with FCTextBlock.
Definition: ff_other.h:17006
void SetFirstPage(ePage page)
Sets the page number for the starting page. If a text block page only should appear on one page,...
Definition: ff_other.h:17118
void SetPageEdgeRef(bool state)
Sets if positioning is referenced from the page edge, or from the margin.
Definition: ff_other.h:17210
void SetPageAssignment(TEXT_ASSIGNMENT assign)
Sets the page assignment (all/odd/even).
Definition: ff_other.h:17098
bool DeepDeleteData() override
Reimplementation to delete block and raw text as well.
Definition: ff_other.h:17231
twobyte GetVerticalPos() const
Returns the vertical position for the text block.
Definition: ff_other.h:16959
TEXT_HORIZONTAL_ALIGN GetHorizontalAlignment() const
Returns the horizontal alignment for the text block on left-side (or all) pages.
Definition: ff_other.h:16861
bool GetIndependentRightPage() const
Returns true if the right-side page positioning is used.
Definition: ff_other.h:16987
TEXT_HORIZONTAL_ALIGN
Horizontal alignment constants for text blocks.
Definition: ff_other.h:16730
@ TEXTHORIZALIGN_RIGHT
Definition: ff_other.h:16734
@ TEXTHORIZALIGN_LEFT
Definition: ff_other.h:16732
@ TEXTHORIZALIGN_CENTER
Definition: ff_other.h:16736
void SetIndependentRightPage(bool state)
Sets if the right-side page positioning is used.
Definition: ff_other.h:17194
TEXT_VERTICAL_ALIGN GetVerticalAlignment() const
Returns the vertical alignment for the text block.
Definition: ff_other.h:16876
TEXT_ASSIGNMENT GetPageAssignment() const
Returns the page assignment (all/odd/even).
Definition: ff_other.h:16906
void SetHorizontalPos(twobyte value)
Sets the horizontal position for the text block.
Definition: ff_other.h:17142
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:16767
void SetVerticalPosRightPage(twobyte value)
Sets the vertical position for the text block for right-side pages.
Definition: ff_other.h:17175
The class for a note definition in a percussion layout.
Definition: ff_other.h:24811
twobyte CalcMidiRawNote(FCPercussionMapNotes *pNotes)
Calculates the MIDI note based on the percussion map. The order ID must match.
Definition: finaleframework.cpp:12941
PERC_NOTE_TYPE GetNoteType() const
Returns the percussion note type.
Definition: finaleframework.cpp:12750
twobyte CalcMidiNote(FCPercussionMapNotes *pNotes)
Calculates the MIDI note based on the percussion map. No mapping to the order ID is made.
Definition: finaleframework.cpp:12955
void SetWholeNotehead(fourbyte value)
Sets the notehead character for whole notes.
Definition: finaleframework.cpp:12912
void SetHalfNotehead(fourbyte value)
Sets the notehead character for half notes.
Definition: finaleframework.cpp:12898
FCPercussionLayoutNote()
The constructor.
Definition: ff_other.h:24867
void SetStaffPosition(twobyte value)
Sets the vertical position of the note.
Definition: finaleframework.cpp:12870
fourbyte GetHalfNotehead() const
Returns the notehead character for half notes.
Definition: finaleframework.cpp:12800
twobyte GetOrderID() const
Returns the order ID (within the layout), when there are multiple notes of the same type in one layou...
Definition: finaleframework.cpp:12761
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:24849
void SetDoubleWholeNotehead(fourbyte value)
Sets the notehead character for double whole notes.
Definition: finaleframework.cpp:12926
void SetNoteType(PERC_NOTE_TYPE value)
Sets the percussion note type.
Definition: finaleframework.cpp:12835
twobyte GetStaffPosition() const
Returns the vertical position of the note.
Definition: finaleframework.cpp:12777
void SetClosedNotehead(fourbyte value)
Sets the notehead character for quarter notes and smaller.
Definition: finaleframework.cpp:12884
fourbyte GetClosedNotehead() const
Returns the notehead character for quarter notes and smaller.
Definition: finaleframework.cpp:12789
void SetOrderID(twobyte value)
Sets the order ID (within the layout), when there are multiple notes of the same type in one layout.
Definition: finaleframework.cpp:12852
fourbyte GetDoubleWholeNotehead() const
Returns the notehead character for double whole notes.
Definition: finaleframework.cpp:12823
fourbyte GetWholeNotehead() const
Returns the notehead character for whole notes.
Definition: finaleframework.cpp:12811
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:25003
PERC_NOTE_TYPE GetRawNoteType() const
Returns the "raw" percussion note type. This includes the order ID, for notes that share the same typ...
Definition: finaleframework.cpp:12738
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:24848
Collection class for FCPercussionLayoutNote class objects (=a percussion layout).
Definition: ff_othercollection.h:1758
A lookup table for FCPercussionLayoutNotes collections.
Definition: ff_other.h:24364
FCPercussionLayoutNotes * GetPercussionLayoutNotes(FCPercussionStaff *pPercussionStaff)
Returns the pointer to a FCPercussionLayoutNotes object based on the supplied percussion staff object...
Definition: finaleframework.cpp:12646
FCPercussionLayoutNotesLookup()
The constructor.
Definition: ff_other.h:24372
FCPercussionLayoutNotes * GetItemAt(int index) const
Overridden GetItemAt method.
Definition: ff_other.h:24401
FCPercussionLayoutNote * FindPercussionLayoutRawNote(FCPercussionStaff *pPercussionStaff, FLAG_16 percussionnote)
Returns the percusion layout note, based on the percussion staff and the raw percussion note ID.
Definition: finaleframework.cpp:12660
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:24366
Class for an individual note in a percussion map, read from Finale's XML file.
Definition: ff_other.h:24156
FCPercussionMapNote(int midikey, int notetype, const char *pszName)
The constructor. Not supported by Lua.
Definition: ff_other.h:24204
int GetMidiNote() const
Returns the midi note value.
Definition: ff_other.h:24242
PERC_NOTE_TYPE GetNoteType() const
Returns the percussion note type.
Definition: ff_other.h:24225
PERCUSSION_NOTE_TYPES
The predefined "virtual" percussion note types in Finale.
Definition: ff_other.h:24166
const char * GetName() const
The name string for the note type. This is usually empty for standard percussion note types.
Definition: ff_other.h:24246
twobyte GetOrderID() const
Returns the order ID for the percussion note type.
Definition: ff_other.h:24231
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:24210
PERC_NOTE_TYPE GetRawNoteType() const
Returns the "raw" percussion note type. This includes the order ID as well.
Definition: ff_other.h:24216
Collection class for FCPercussionMapNote class objects, used by the FCInstrumentDef class.
Definition: ff_other.h:24260
FCPercussionMapNote * FindRawNoteType(PERC_NOTE_TYPE rawnotetype)
Finds and returns the raw note type in the collection.
Definition: ff_other.h:24291
FCPercussionMapNotes(twobyte percussionid)
The constructor. Not supported by Lua.
Definition: ff_other.h:24269
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:24277
FCPercussionMapNote * FindMidiNote(twobyte midinote)
Finds and returns a MIDI note in the collection.
Definition: ff_other.h:24307
twobyte GetPercussionID() const
Returns the percussion map ID for the loaded collection.
Definition: ff_other.h:24275
FCPercussionMapNote * GetItemAt(int index) const
Overridden GetItemAt method.
Definition: ff_other.h:24283
A lookup table for FCPercussionMapNotes notes.
Definition: ff_other.h:24328
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:24330
FCPercussionMapNotesLookup()
The constructor.
Definition: ff_other.h:24336
FCPercussionMapNotes * GetPercussionMapNotes(FCInstrumentDef *pInstrumentDef)
Returns the pointer to a FCPercussionMapNotes object based on the supplied instrument definition.
Definition: finaleframework.cpp:12627
Class that stores the information for drum mapping, either for a staff or staff style.
Definition: ff_other.h:7106
FCPercussionStaff()
The constructor.
Definition: ff_other.h:7147
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:7182
CMPER GetPercussionLibrary()
Returns the number to the percussion library that's used. This is loaded by the percussion layout,...
Definition: ff_other.h:7160
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:7134
FCPercussionLayoutNotes * CreateLayoutNotes()
Creates a percussion layout for the percussion staff. A more effiencent approach is using FCPercussio...
Definition: finaleframework.cpp:7813
void SetPercussionLibrary(CMPER cmper)
Set the percussion library that's used. This is loaded by the percussion layout, (the FCPercussionLay...
Definition: ff_other.h:7169
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:7133
Simple class for the representation of x, y coordinates.
Definition: ff_base.h:4861
double GetY() const
Returns the y position.
Definition: ff_base.h:4911
double GetX() const
Returns the x position.
Definition: ff_base.h:4905
The class for raw text objects. All other text classes are based on this class, but it can also be us...
Definition: ff_text.h:17
bool Load(twobyte number)
Loads the text with the indicated text number.
Definition: finaleframework.cpp:4407
FCString * CreateString() const
Creates a string object with the loaded text. If the string doesn't exist (or if it's empty),...
Definition: finaleframework.cpp:4491
Class that handles separate placement for repeats.
Definition: ff_other.h:17270
twobyte GetMeasure() const override
Sets the measure that the separate placement should be matched to.
Definition: ff_other.h:17425
SEPARATEPLACEMENT_MODES GetMode() const
Gets the type of data that should be used when reading/saving the record.
Definition: ff_other.h:17392
void SetHorizontalOffset2(Evpu16 value)
Sets the 2nd horizontal offset, compared to the standard positioning.
Definition: ff_other.h:17550
eStaff GetStaff() const override
Returns the staff that the separate placement should be matched to.
Definition: ff_other.h:17412
void SetVisible(bool state)
Sets the visibility state. (Whether "Show" is checked in the context menu.)
Definition: ff_other.h:17615
Evpu16 GetVerticalOffset1() const
Returns the 1st vertical offset, compared to the standard positioning.
Definition: ff_other.h:17452
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:17317
FCSeparatePlacement()
The constructor.
Definition: ff_other.h:17333
void SetVerticalOffset2(Evpu16 value)
Sets the 2nd vertical offset, compared to the standard positioning.
Definition: ff_other.h:17572
SEPARATEPLACEMENT_MODES
Modes for which placement type to load.
Definition: ff_other.h:17302
@ SEPARMODE_BACKWARDREPEAT
Definition: ff_other.h:17304
@ SEPARMODE_ENDINGREPEATTEXT
Definition: ff_other.h:17313
@ SEPARMODE_TEXTREPEAT
Definition: ff_other.h:17307
@ SEPARMODE_ENDINGREPEAT
Definition: ff_other.h:17310
void SetVerticalOffset1(Evpu16 value)
Sets the 1st horizontal offset, compared to the standard positioning.
Definition: ff_other.h:17540
bool HasStaffValue() const override
Overridden method (returning true) since this class contains a staff value.
Definition: ff_other.h:17415
bool GetVisible() const
Returns the visibility state. (Whether "Show" is checked in the context menu.)
Definition: ff_other.h:17592
Evpu16 GetHorizontalOffset1() const
Returns the 1st horizontal offset, compared to the standard positioning.
Definition: ff_other.h:17441
Evpu16 GetHorizontalOffset2() const
Returns the 2nd horizontal offset, compared to the standard positioning.
Definition: ff_other.h:17462
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:17316
void SetHorizontalOffset1(Evpu16 value)
Sets the 1st horizontal offset, compared to the standard positioning.
Definition: ff_other.h:17529
void SetStaff(eStaff staff)
Sets the staff that the separate placement should be matched to.
Definition: ff_other.h:17504
Evpu16 GetVerticalOffset2() const
Returns the 2nd horizontal offset, compared to the standard positioning.
Definition: ff_other.h:17484
void SetMeasure(twobyte meas)
Sets the measure that the separate placement should be matched to.
Definition: ff_other.h:17514
void SetMode(SEPARATEPLACEMENT_MODES mode)
Sets the type of data that should be used when reading/saving the record.
Definition: ff_other.h:17350
Collection class for FCSeparatePlacement records, that handles separate placements in repeats.
Definition: ff_othercollection.h:1020
Class for a shape definition (as in Finale's Shape selection dialog).
Definition: ff_other.h:2233
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:2469
fourbyte GetDataCount() const
Returns the number of elements in the data array.
Definition: ff_other.h:2666
bool GetFontInfo(int index, FCFontInfo *pFontInfo)
Gets the font info from a "setfont" tag.
Definition: finaleframework.cpp:38533
bool Load(CMPER itemno) override
Loads the indicated item in a special way, since there's a crash bug when loading empty shapes,...
Definition: ff_other.h:2527
bool DeleteData() override
Deletes the associated data from Finale's database. Be careful when deleting multiple objects.
Definition: ff_other.h:2512
bool SaveWithType(SHAPEDEF_TYPES shapedeftype)
Saves an existing shape definition with the Save() method, but also saves the type of shape with the ...
Definition: ff_other.h:2638
void InstructionDebugDump(int instructionindex)
Special "DebugDump" to get the elements within an instruction.
Definition: finaleframework.cpp:38647
bool LoadNext() override
Different approach for loading next for shapes.
Definition: ff_other.h:2519
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:2470
FCStrings * CreateTextStrings()
Returns a string collection with all the texts in the shape.
Definition: finaleframework.cpp:38487
bool SaveNewWithType(SHAPEDEF_TYPES shapedeftype)
Saves a new shape definition the with the SaveNew() method, but also saves the type of shape with the...
Definition: ff_other.h:2603
int GetInstructionSize(int index)
Returns how many data blocks an instruction contains. (This is a fixed number based on the instructio...
Definition: ff_other.h:2726
FCShapeDefInstructions * CreateInstructions()
Creates a collection with all the instructions for the shape.
Definition: finaleframework.cpp:38311
bool _GetIsEmptyShape()
For internal use.
Definition: ff_other.h:2488
bool RebuildInstructions(FCShapeDefInstructions *pCollection)
Rebuilds the shape data from a collection (containing all the instructions for the shape).
Definition: finaleframework.cpp:38377
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:2820
bool ExportAsSVGFile(FCString *pFileName, float scaling, const char *pszUnit)
Saves the shape as a SVG (Scalable Vector File) file. An existing file with the same full path will b...
Definition: finaleframework.cpp:38603
ETAG GetInstructionTag(int index)
Returns the instruction tag at a certain index in the shape path.
Definition: ff_other.h:2716
SHAPEDEF_TYPES GetType() const
Returns the shape definition type.
Definition: ff_other.h:2583
FCShapeDef()
The constructor.
Definition: ff_other.h:2473
fourbyte GetInstructionsCount() const
Returns the total number of elements in the instructions array.
Definition: ff_other.h:2688
bool SetFontInfo(int index, FCFontInfo *pFontInfo)
Sets the font info to a "setfont" tag.
Definition: finaleframework.cpp:38567
bool CalcProtected()
Returns true if the shape is marked as "protected" by Finale and shouldn't be deleted....
Definition: ff_other.h:2492
SHAPEDEF_TYPES
The shape definition types, to be used with FCShapeDef::SaveNewWithType(), etc.
Definition: ff_other.h:2238
bool LoadFirst() override
Different approach for loading first for shapes.
Definition: ff_other.h:2507
Helper class for FCShapeDef.
Definition: ff_other.h:1290
void Init_Stroke()
Creates a st_stroke shape instruction.
Definition: ff_other.h:1753
void Init_Ellipse(int width, int height)
Inits a Ellipse instruction.
Definition: ff_other.h:1683
double GetFloatData(int index)
Returns the floating point data contained at the 0-based index position.
Definition: finaleframework.cpp:38237
const char * GetTagAsString() const
Returns the instruction tag as a human-readable C-type string, such as "startobject",...
Definition: ff_other.h:1444
virtual ~FCShapeDefInstruction()
The destructor.
Definition: finaleframework.cpp:38102
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:1386
fourbyte GetFourbyteData(int index) const
Returns the fourbyte data contained at the 0-based index position.
Definition: finaleframework.cpp:38220
void Init_Null()
Creates a NULL shape instruction.
Definition: ff_other.h:1760
void _SetMemory(EDTPathInst *pPathInstruction, void *pPathData, int offset)
For internal use only.
Definition: finaleframework.cpp:38195
bool IsIdentical(const __FCBase *pTestObject) const override
Returns true if the shape def instructions are identical.
Definition: ff_other.h:1425
void Init_SetGrey(int greyvalue)
Sets the grey percent (0-100).
Definition: ff_other.h:1657
void Init_ClosePath()
Inits a ClosePath instruction.
Definition: ff_other.h:1672
void Init_RLineTo(int x, int y)
Creates a st_rlineto shape instruction.
Definition: ff_other.h:1736
void Init_SetFont(FCFontInfo *pFontInfo)
Creates a st_setfont shape instruction.
Definition: ff_other.h:1716
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:1768
SHAPEDEFTAGS
The instruction tag constants that can be returned from the GetTag method.
Definition: ff_other.h:1321
@ SHAPETAG_SETGRAY
Definition: ff_other.h:1353
@ SHAPETAG_SETDASH
Definition: ff_other.h:1347
@ SHAPETAG_CURVETO
Definition: ff_other.h:1362
@ SHAPETAG_RMOVETO
Definition: ff_other.h:1341
@ SHAPETAG_SETFONT
Definition: ff_other.h:1323
@ SHAPETAG_LINEWIDTH
Definition: ff_other.h:1344
@ SHAPETAG_STROKE
Definition: ff_other.h:1338
@ SHAPETAG_NULL
Definition: ff_other.h:1377
@ SHAPETAG_STARTGROUP
Definition: ff_other.h:1329
@ SHAPETAG_RECTANGLE
Definition: ff_other.h:1368
@ SHAPETAG_STARTOBJECT
Definition: ff_other.h:1326
@ SHAPETAG_ENDGROUP
Definition: ff_other.h:1332
@ SHAPETAG_SLUR
Definition: ff_other.h:1365
@ SHAPETAG_BRACKET
Definition: ff_other.h:1374
@ SHAPETAG_DRAWCHAR
Definition: ff_other.h:1335
@ SHAPETAG_CLOSEPATH
Definition: ff_other.h:1371
@ SHAPETAG_FILLSOLID
Definition: ff_other.h:1359
@ SHAPETAG_ELLIPSE
Definition: ff_other.h:1356
@ SHAPETAG_LINETO
Definition: ff_other.h:1350
void Init_Bracket(int brackettype)
Creates a bracket shape instruction.
Definition: ff_other.h:1745
void Init_EndGroup()
Creates a st_endgroup shape instruction.
Definition: ff_other.h:1602
void Init_CurveTo(int x1, int y1, int x2, int y2, int endpt_x, int endpt_y)
Creates a st_curveto shape instruction.
Definition: ff_other.h:1618
void Init_DrawChar(eUniChar16 character)
Creates a st_drawchar shape instruction.
Definition: ff_other.h:1706
void Init_Slur(int x1, int y1, int x2, int y2, int endpt_x, int endpt_y)
Creates a st_slur shape instruction.
Definition: ff_other.h:1631
void Init_StartGroup(int xorigin, int yorigin, int left, int top, int right, int bottom, int xtransform=1000, int ytransform=1000, int rotation=0)
Creates a st_startgroup shape instruction.
Definition: ff_other.h:1583
void Init_RMoveTo(int x, int y)
Creates a st_rmoveto shape instruction.
Definition: ff_other.h:1609
void Init_SetDash(int dashlength, int spacebetween)
Creates a st_setdash shape instruction.
Definition: ff_other.h:1727
bool SetFourbyteData(int index, fourbyte fbvalue)
Sets the fourbyte data contained at the 0-based index position.
Definition: ff_other.h:1534
int GetCount() const
Returns the number of parameter elements in the instruction.
Definition: ff_other.h:1411
void Init_StartObject(int xorigin, int yorigin, int left, int top, int right, int bottom, int xtransform=1000, int ytransform=1000, int rotation=0)
Creates a st_startobject shape instruction.
Definition: ff_other.h:1563
void Init_LineWidth(int linewidth)
Creates a st_linewidth shape instruction.
Definition: ff_other.h:1647
void Init_Rectangle(int width, int height)
Inits a Rectangle instruction.
Definition: ff_other.h:1695
void Init_FillSolid()
Inits a FillSolid instruction, which fills the path.
Definition: ff_other.h:1665
ETAG GetTag() const
Returns the instruction tag as a constant.
Definition: ff_other.h:1419
Helper class for FCShapeDef.
Definition: ff_other.h:1804
FCShapeDefInstruction * AddStartGroup(FCPoint *pOrigin, FCPoint *pBoundLeftTop, FCPoint *pBoundRightBottom, int xtransform=1000, int ytransform=1000, int rotation=0)
Adds a StartGroup instruction. All instructions in the group will transform according to the group....
Definition: ff_other.h:1872
FCShapeDefInstruction * AddSetGrey(int percent)
Adds a SetGrey instruction.
Definition: ff_other.h:1925
FCShapeDefInstruction * AddCurveToDetails(int x1, int y1, int x2, int y2, int endpt_x, int endpt_y)
Adds a CurveTo instruction with all parameters set.
Definition: ff_other.h:2033
FCShapeDefInstruction * AddCurveTo(int ctrlpt_height=72)
Adds a standard CurveTo instruction.
Definition: ff_other.h:2001
FCShapeDefInstruction * AddSetDash(int dashlength, int spacebetween)
Adds a SetDash instruction.
Definition: ff_other.h:2076
FCShapeDefInstruction * AddDrawChar(eUniChar16 character)
Adds a DrawChar instruction.
Definition: finaleframework.cpp:38258
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:1806
FCShapeDefInstruction * GetItemAt(int index) const
Overridden version of GetItemAt().
Definition: ff_other.h:1812
FCShapeDefInstruction * AddClosePath()
Adds a ClosePath instruction.
Definition: ff_other.h:1950
FCShapeDefInstruction * AddSetFont(FCFontInfo *pFontInfo)
Adds a SetFont instruction.
Definition: ff_other.h:2146
FCShapeDefInstruction * AddStroke()
Adds a Stroke instruction (which draws a path).
Definition: ff_other.h:2061
FCShapeDefInstruction * AddRMoveTo(int x, int y)
Adds a RMoveTo instruction (=relative move to).
Definition: ff_other.h:2129
FCShapeDefInstruction * AddEllipse(int width, int height)
Adds an Ellipse instruction (draws a circle).
Definition: ff_other.h:1965
FCShapeDefInstruction * AddSolidLineStyle()
A shortcut method to add a SetDash(18, 0) instruction.
Definition: ff_other.h:2117
FCShapeDefInstruction * AddRLineTo(int x, int y)
Adds a RLineTo instruction (=relative line to).
Definition: ff_other.h:2091
FCShapeDefInstruction * AddLineWidth(int linewidth)
Adds a LineWidth instruction.
Definition: ff_other.h:1911
FCShapeDefInstruction * AddNull()
Adds a Null instruction.
Definition: ff_other.h:1821
FCShapeDefInstruction * AddFillSolid()
Adds a FillSolid instruction, which fills the path.
Definition: ff_other.h:1937
FCShapeDefInstruction * AddEndGroup()
Adds a LineWidth instruction, which closes the group that was started with AddStartGroup.
Definition: ff_other.h:1895
FCShapeDefInstruction * AddStartObject(FCPoint *pOrigin, FCPoint *pBoundLeftTop, FCPoint *pBoundRightBottom, int xtransform=1000, int ytransform=1000, int rotation=0)
Adds a StartObject instruction.
Definition: ff_other.h:1845
FCShapeDefInstruction * AddSlur(int ctrlpt_height=72)
Adds a standard Slur instruction.
Definition: ff_other.h:2048
FCShapeDefInstruction * AddBracket(int brackettype)
Adds a Bracket instruction.
Definition: ff_other.h:2105
FCShapeDefInstruction * AddRectangle(int width, int height)
Adds an Rectangle instruction (draws a circle).
Definition: ff_other.h:1980
FCShapeDefInstruction * AddDrawCharsString(FCString *pString)
Adds a string as a series of DrawChar instructions from a FCString object. This method supports 16-bi...
Definition: ff_other.h:2200
FCShapeDefInstruction * AddDrawChars(const char *pszString)
Adds a string as a series of DrawChar instructions. This method doesn't support Unicode.
Definition: ff_other.h:2177
Class for a shape expression definition.
Definition: ff_other.h:15488
void SetNoPrint(bool state)
Sets the "No Print" state.
Definition: ff_other.h:15820
bool GetUseCategoryPos() const
Returns true if the expression is marked to use the category positioning.
Definition: ff_other.h:15702
void GetDescription(FCString *pName)
Gets the description text for the shape expression definition.
Definition: finaleframework.cpp:11937
bool GetAllowHorizontalStretching() const
Returns the "Allow Horizontal Stretching" state.
Definition: ff_other.h:15603
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:16033
bool AssignShapeDef(FCShapeDef *pShapeDef)
Assigns a saved FCShapeDef object to the shape expression definition.
Definition: ff_other.h:16009
FCShapeExpressionDef()
The constructor.
Definition: finaleframework.cpp:11847
FCString * CreateDescription()
Creates a FCString object, containing the description text.
Definition: finaleframework.cpp:11996
void SetUseCategoryPos(bool value)
Sets if the "use category positioning" should be checked or not.
Definition: ff_other.h:15930
twobyte GetVerticalBaselineOffset() const
Returns the vertical "Additional Baseline Offset" in the shape expression definition.
Definition: ff_other.h:15758
twobyte GetCategoryID() const
Returns the category ID for the expression definition.
Definition: ff_other.h:15841
void SetAllowHorizontalStretching(bool state)
Sets the "Allow Horizontal Stretching" state.
Definition: ff_other.h:15811
bool GetNoPrint() const
Returns the "No Print" state.
Definition: ff_other.h:15612
void SetExecutableShapeID(twobyte shapeID)
Sets the executable shape ID for the expression def.
Definition: ff_other.h:15790
FCCategoryDef::HORIZ_JUSTIFICATION GetHorizontalJustification() const
Returns the "Horizontal Justification" setting in the shape expression definition.
Definition: ff_other.h:15659
virtual ~FCShapeExpressionDef()
The destructor.
Definition: finaleframework.cpp:11856
bool LoadNext() override
Overridden LoadNext, since the data loading mechanism requires it for LoadAll() to work.
Definition: ff_other.h:15564
void SetVerticalBaselineOffset(twobyte value)
Sets the vertical "Additional Baseline Offset" in the shape expression definition.
Definition: ff_other.h:15988
void SetHorizontalJustification(FCCategoryDef::HORIZ_JUSTIFICATION value)
Sets the "Horizontal Justification" in the shape expression definition.
Definition: ff_other.h:15875
void SetDescription(FCString *pName)
Sets the description text for the shape expression definition.
Definition: finaleframework.cpp:11961
void SetVerticalEntryOffset(twobyte value)
Sets the vertical "Additional Entry Offset" in the shape expression definition.
Definition: ff_other.h:15956
void SetBreakMMRest(bool state)
Sets the "Break Multimeasure Rest" state.
Definition: ff_other.h:15829
FCCategoryDef::VERT_ALIGNMENT GetVerticalAlignmentPoint() const
Returns the vertical alignment point for the expression definition positioning.
Definition: ff_other.h:15748
void SetVerticalAlignmentPoint(FCCategoryDef::VERT_ALIGNMENT value)
Sets the vertical alignment point for the expression definition positioning.
Definition: ff_other.h:15972
bool LoadFirst() override
Overridden LoadFirst, since the data loading mechanism requires it for LoadAll() to work.
Definition: ff_other.h:15561
void SetID(twobyte shapeID)
Sets the shape ID (of the FCShapeDef class).
Definition: ff_other.h:15777
void SetHorizontalAlignmentPoint(FCCategoryDef::HORIZ_ALIGNMENT value)
Sets the "Horizontal Alignment Point" setting in the shape expression definition.
Definition: ff_other.h:15911
void SetUseExecutableShape(bool state)
Sets the use of executable shape. Normally this isn't called directly. Instead, use SetExecutableShap...
Definition: ff_other.h:15802
twobyte GetExecutableShapeID()
Returns the executable shape ID.
Definition: ff_other.h:15632
FCCategoryDef::HORIZ_ALIGNMENT GetHorizontalAlignmentPoint() const
Returns the "Horizontal Alignment Point" setting in the shape expression definition.
Definition: ff_other.h:15689
twobyte GetHorizontalOffset() const
Returns the "Additional Horizontal Offset" value in the shape expression definition.
Definition: ff_other.h:15718
twobyte GetVerticalEntryOffset() const
Returns the vertical "Additional Entry Offset" in the shape expression definition.
Definition: ff_other.h:15728
void SetHorizontalOffset(twobyte value)
Sets the "Additional Horizontal Offset" in the shape expression definition.
Definition: ff_other.h:15946
bool GetUseExecutableShape() const
Returns true if an executable is used for the expression def.
Definition: ff_other.h:15593
twobyte GetID() const
Returns the shape ID (of the FCShapeDef class).
Definition: ff_other.h:15642
FCShapeDef * CreateShapeDef()
Creates a FCShapeDef object for the shape that's connected to the shape expression definition....
Definition: finaleframework.cpp:12005
bool GetBreakMMRest() const
Returns the "Break Multimeasure Rest" state.
Definition: ff_other.h:15621
void SetCategoryID(twobyte ID)
Sets the category ID for the expression definition.
Definition: ff_other.h:15856
The class for a staff in the score. It is also a base class for staff styles.
Definition: ff_other.h:11503
FCPercussionStaff * CreatePercussionStaff()
Creates a percussion staff (or staff style) object, if the staff is set to percussion.
Definition: finaleframework.cpp:9224
void SetAutoNumberingStyle(STAFFAUTONUMBER_STYLE value)
Sets the auto-numbering style for this staff. For Finale to recognize it, you must also set SetUseAut...
Definition: ff_other.h:12095
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:11898
bool GetUseAutoNumberingStyle() const
Gets the option of whether to use the auto-numbering style for this staff.
Definition: ff_other.h:12039
FCInstrumentPlaybackData * CreateInstrumentPlaybackData()
Creates a FCInstrumentPlaybackData object for the staff.
Definition: finaleframework.cpp:9293
FCInstrumentDef * CreateLayerInstrumentDef(int layer)
Creates the instrument definition object for the staff or staff style.
Definition: finaleframework.cpp:9315
int CalcPercussionLayoutID()
Calculates the percussion layout ID for the staff or staff style.
Definition: finaleframework.cpp:9215
STAFFAUTONUMBER_STYLE GetAutoNumberingStyle() const
Gets the auto-numbering style for this staff. It is only valid if GetUseAutoNumberingStyle is true.
Definition: ff_other.h:12062
FCStaff()
The constructor.
Definition: ff_other.h:11982
void SetUseAutoNumberingStyle(bool state)
Sets the option of whether to use the auto-numbering style for this staff.
Definition: ff_other.h:12078
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:12173
STAFFAUTONUMBER_STYLE
Style types for the GetAutoNumberingStyle and SetAutoNumberingStyle methods.
Definition: ff_other.h:11959
@ STAFFAUTONUMBER_ARABIC_SUFFIX
Definition: ff_other.h:11961
@ STAFFAUTONUMBER_ARABIC_PREFIX
Definition: ff_other.h:11973
@ STAFFAUTONUMBER_ORDINAL_PREFIX
Definition: ff_other.h:11967
@ STAFFAUTONUMBER_ALPHA_SUFFIX
Definition: ff_other.h:11970
@ STAFFAUTONUMBER_ROMAN_SUFFIX
Definition: ff_other.h:11964
bool SavePercussionLayout(int layoutID, int mapID)
Sets up and saves a percussion staff. The supplied percussion layout ID will be used....
Definition: finaleframework.cpp:9244
FCFretInstrumentDef * CreateFretInstrumentDef()
Creates a FCFretInstrumentDef object for the connected tablature instrument. Might return NULL if the...
Definition: finaleframework.cpp:9304
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:11897
An object that contains one staff list section (out of 4). Before data is loaded/saved,...
Definition: ff_other.h:25043
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:25179
bool RemoveElement(twobyte element)
Removes an element from the staff list.
Definition: finaleframework.cpp:13165
bool DeleteData() override
DeleteData() is currently not supported.
Definition: ff_other.h:25195
int GetStaff(int index)
Gets a staff number for a reference index.
Definition: ff_other.h:25246
bool RemoveStaff(twobyte staffnumber)
Removes a staff number from the staff list.
Definition: ff_other.h:25412
bool AddElement(twobyte elementnumber)
Adds an element to the staff list.
Definition: finaleframework.cpp:13141
bool IncludesTopStaff()
Returns true if the "Top Staff" is included in the staff list.
Definition: ff_other.h:25281
bool RemoveBottomStaff()
Removes a "Bottom Staff" from the staff list.
Definition: ff_other.h:25401
int GetStaffCount() const
Returns the number of staves that are part of the staff list. Top/bottom staff settings are not inclu...
Definition: ff_other.h:25225
bool SaveNew() override
SaveNew() is not supported.
Definition: ff_other.h:25189
FCStaffList()
the constructor.
Definition: ff_other.h:25089
bool AddBottomStaff()
Adds a "Bottom Staff" to the staff list.
Definition: ff_other.h:25373
FCString * CreateNameString()
Loads the name of the staff list and puts it in an object.
Definition: finaleframework.cpp:13070
bool IncludesBottomStaff()
Returns true if the "Bottom Staff" is included in the staff list.
Definition: ff_other.h:25290
bool IncludesStaff(twobyte staffnumber)
Returns true if the staff number is included in the staff list.
Definition: ff_other.h:25301
bool SaveNameString(FCString *pString)
Saves the name of the staff list.
Definition: finaleframework.cpp:13105
void SetMode(STAFFLIST_MODES mode)
Sets the list of data that should be used when reading/saving the record.
Definition: ff_other.h:25126
bool RemoveTopStaff()
Removes a "Top Staff" from the staff list.
Definition: ff_other.h:25390
bool IsElementAvailable(twobyte stafflistelement)
Returns true if the element (staff or top/bottom setting) is available.
Definition: ff_other.h:25266
bool LoadNext() override
Overridden LoadNext so the FCStaffLists collection work correctly.
Definition: ff_other.h:25198
bool Save() override
Overridden Save method, since the staff list is of dynamic size.
Definition: finaleframework.cpp:13009
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:25094
bool Load(CMPER itemno) override
Overridden Load() method, since the staff list is of dynamic size.
Definition: finaleframework.cpp:12974
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:25093
STAFFLIST_MODES
Modes for loading/saving the staff list.
Definition: ff_other.h:25067
bool AddTopStaff()
Adds a "Top Staff" to the staff list.
Definition: ff_other.h:25361
int GetElementCount() const
Returns the number of elements in the staff list. Both staff numbers and top/bottom staff are include...
Definition: ff_other.h:25205
bool AddStaff(twobyte staffnumber)
Adds a staff number to the staff list.
Definition: ff_other.h:25348
Class for staff (or staff style) name positioning data.
Definition: ff_other.h:7202
twobyte GetHorizontalOffset() const
Returns the horizontal offset adjustment value.
Definition: ff_other.h:7274
void SetUsePositioning(bool state)
Sets if the positioning is activated for the staff (or staff style).
Definition: ff_other.h:7367
Evpu16 CalcHorizontalPosition()
Calculates the actual horizontal position, based on the preferences.
Definition: finaleframework.cpp:7849
void SetJustification(FLAG_16 justification)
Sets the default justification for the staff text.
Definition: ff_other.h:7332
void SetAlignment(FLAG_16 alignment)
Sets the default alignment for the staff text.
Definition: ff_other.h:7346
bool GetUsePositioning() const
Returns if the positioning is activated for the staff (or staff style).
Definition: ff_other.h:7308
FLAG_16 GetAlignment() const
Returns the default alignment for the staff text.
Definition: ff_other.h:7296
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:7233
FCStaffNamePosition(bool fullname)
The constructor.
Definition: finaleframework.cpp:7828
void SetHorizontalOffset(twobyte value)
Returns the horizontal offset adjustment value.
Definition: ff_other.h:7318
FLAG_16 GetJustification() const
Returns the default justification for the staff text.
Definition: ff_other.h:7288
void SetVerticalOffset(twobyte value)
Returns the vertical offset adjustment value.
Definition: ff_other.h:7324
Evpu16 CalcVerticalPosition()
Calculates the actual vertical position, based on the preferences.
Definition: finaleframework.cpp:7861
twobyte GetVerticalOffset() const
Returns the vertical offset adjustment value.
Definition: ff_other.h:7280
void SetExpandSingleWord(bool state)
Sets the default "expand single word" state.
Definition: ff_other.h:7358
bool GetExpandSingleWord() const
Returns the default "expand single word" state.
Definition: ff_other.h:7302
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:7234
Class for staff style assignments to a staff.
Definition: ff_other.h:19437
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:19589
void SetEndMeasure(eMeas value)
Sets the end measure for the applied staff style.
Definition: ff_other.h:19539
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:19466
FCStaffStyleAssign()
The constructor.
Definition: ff_other.h:19482
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:19465
eMeas GetStartMeasure() const
Returns the start measure number of the assigned staff style.
Definition: ff_other.h:19503
eStaff GetStaff() const override
Returns the staff number for a loaded staff style region.
Definition: ff_other.h:19557
twobyte GetStyleID() const
Returns the staff style ID, for use with the FCStaffStyleDef class. Please note that the style ID is ...
Definition: ff_other.h:19496
void SetStartMeasure(eMeas value)
Sets the start measure for the applied staff style.
Definition: ff_other.h:19527
TimeEdu32 GetEndMeasurePos() const
Returns the end measure EDU position of the assigned staff style.
Definition: ff_other.h:19521
void SetStyleID(twobyte value)
Sets the staff style definition ID for the applied staff style.
Definition: ff_other.h:19551
eMeas GetEndMeasure() const
Returns the end measure number of the assigned staff style.
Definition: ff_other.h:19515
void SetStartMeasurePos(TimeEdu32 value)
Sets the start measure position for the applied staff style.
Definition: ff_other.h:19533
void SetEndMeasurePos(TimeEdu32 value)
Sets the end measure position for the applied staff style.
Definition: ff_other.h:19545
bool IsOverlapping(FCMusicRegion *pRegion)
Returns true if the supplied FCMusicRegion object is within staff style region.
Definition: ff_other.h:19570
void SetEndMeasurePosRight()
Sets the the end measure pos to the right-most edge of the staff style assignment's end measure.
Definition: ff_other.h:19564
TimeEdu32 GetStartMeasurePos() const
Returns the start measure EDU position of the assigned staff style.
Definition: ff_other.h:19509
Class for a staff style definition.
Definition: ff_other.h:18244
void SetUseShowNoteShapes(bool state)
Sets if note shapes should be part of the staff style or not.
Definition: finaleframework.cpp:12138
void SetUseShowPartStaffNames(bool state)
Sets if staff name display in parts should be part of the staff style or not.
Definition: ff_other.h:19150
void SetUseRedisplayOtherLayerAccidentals(bool state)
Sets if "Redisplay accidentals in other layers within measures" should be part of the staff style or ...
Definition: finaleframework.cpp:12152
void SetUseShowAugmentationDots(bool state)
Sets if augmentation dot setting should be part of the staff style or not.
Definition: ff_other.h:19081
bool GetCopyable() const
Returns if the staff style definition should be copyable or not.
Definition: ff_other.h:18682
bool GetUseShowRepeats() const
Returns true if the repeat bar display is active for the staff style definition.
Definition: ff_other.h:18763
void SetUseShowTies(bool state)
Sets if the display of ties should be part of the staff style or not.
Definition: ff_other.h:19171
void SetUseShowFretboards(bool state)
Sets if fretboard display should be part of the staff style or not.
Definition: ff_other.h:19091
void SetUseBreakRepeatBarlines(bool state)
Sets if the "Break repeat barlines between staves" setting should be part of the staff style or not.
Definition: ff_other.h:19247
bool GetUseDisplayEmptyRests() const
Returns true if "Display Rests in empty measures" state should be used for the staff style definition...
Definition: ff_other.h:18836
void SetUseShowChords(bool state)
Sets if chords should be part of the staff style or not.
Definition: ff_other.h:19071
bool GetUseShowPartStaffNames() const
Returns true if the staff name display in parts is active for the staff style definition.
Definition: ff_other.h:18793
void GetName(FCString *pString)
Gets the name for the staff style.
Definition: finaleframework.cpp:12064
void SetUseFullName(bool state)
Sets if the full staff name should be part of the staff style or not.
Definition: ff_other.h:19268
bool GetUseNoKeySigShowAccidentals() const
Returns true if "Hide key signature & show all accidentals" (available in the Finale 2014 Score Manag...
Definition: finaleframework.cpp:12117
bool GetUseShowRests() const
Returns true if the "Show Rests" is active for the staff style definition.
Definition: ff_other.h:18770
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:19418
bool GetUseNotationStyle() const
Returns true if the notation style should be used for the staff style definition.
Definition: ff_other.h:18829
void SetUseHideMode(bool state)
Sets if the hide mode (such as GetHideMode) should be part of the staff style or not.
Definition: ff_other.h:19296
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:18621
void SetUseIndependentTimeSig(bool state)
Sets if independent time signatures should be part of the staff style or not.
Definition: ff_other.h:19289
void SetUseShowLyrics(bool state)
Sets if lyrics display should be part of the staff style or not.
Definition: ff_other.h:19101
bool GetUseShowMeasureNumbers() const
Returns true if the measure number is active for the staff style definition.
Definition: ff_other.h:18707
bool GetUseHideMode() const
Returns true if the hide mode (such as GetHideMode) should be used for the staff style definition.
Definition: ff_other.h:18930
bool GetUseStafflineAdjustments() const
Returns true if the staffline adjustments settings should be used for the staff style definition.
Definition: ff_other.h:18860
void SetUseDisplayEmptyRests(bool state)
Sets if "Display Rests in empty measures" state should be part of the staff style or not.
Definition: ff_other.h:19202
bool GetUseIndependentKeySig() const
Returns true if independent key signatures should be used for the staff style definition.
Definition: ff_other.h:18916
void SetUseBreakBarlines(bool state)
Sets if the "Break barlines between staves" setting should be part of the staff style or not.
Definition: ff_other.h:19240
void SetCopyable(bool value)
Sets if the staff style definition should be copyable or not.
Definition: ff_other.h:19003
bool GetUseIndependentTimeSig() const
Returns true if independent time signatures should be used for the staff style definition.
Definition: ff_other.h:18923
void SetUseShowNoteColors(bool state)
Sets if note colors should be part of the staff style or not.
Definition: ff_other.h:19331
void SetUseAbbreviatedName(bool state)
Sets if the abbreviated staff name should be part of the staff style or not.
Definition: ff_other.h:19275
bool GetUseShowStems() const
Returns true if the stem display is active for the staff style definition. This flag activates or dea...
Definition: ff_other.h:18801
void SetUseShowRepeats(bool state)
Sets if repeat bar display should be part of the staff style or not.
Definition: ff_other.h:19111
bool GetUseTransposition() const
Returns true if the transposition settings should be used for the staff style definition.
Definition: ff_other.h:18867
void SetUseIndependentKeySig(bool state)
Sets if independent key signatures should be part of the staff style or not.
Definition: ff_other.h:19282
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:18622
void SetUseNotationStyle(bool state)
Sets if the notation style should be part of the staff style or not.
Definition: ff_other.h:19195
void SetName(FCString *pString)
Sets the name for the staff style.
Definition: finaleframework.cpp:12081
void SetUseShowRests(bool state)
Sets if "Show Rests" should be part of the staff style or not.
Definition: ff_other.h:19121
bool GetUseFullName() const
Returns true if the full staff name should be used for the staff style definition.
Definition: ff_other.h:18902
void SetUseAllowHiding(bool state)
Sets if the "optimization" state should be part of the staff style or not.
Definition: ff_other.h:19209
void SetUseShowKeySignatures(bool state)
Sets if "Display Key Sig" should be part of the staff style or not.
Definition: ff_other.h:19020
bool GetUseDefaultClef() const
Returns true if the default clef setting should be used for the staff style definition.
Definition: ff_other.h:18850
void SetUseShowMeasureNumbers(bool state)
Sets if measure numbers should be part of the staff style or not.
Definition: ff_other.h:19030
bool GetUseAltNotationStyle() const
Returns true if the alternate notation style should be used for the staff style definition.
Definition: ff_other.h:18958
bool GetUseFlatBeams() const
Returns true if the flat beams state should be used for the staff style definition.
Definition: ff_other.h:18822
void SetUseShowTextRepeats(bool state)
Sets if the text repeat display setting should be part of the staff style or not.
Definition: ff_other.h:19254
bool GetUseShowFretboards() const
Returns true if the fretboard display is active for the staff style definition.
Definition: ff_other.h:18749
bool GetUseShowNoteColors() const
Returns true if note colors should be used for the staff style definition.
Definition: ff_other.h:18965
void SetUseShowStems(bool state)
Returns true if the stem display is active for the staff style definition. This flag activates or dea...
Definition: ff_other.h:19161
bool GetUseShowChords() const
Returns true if the chords is active for the staff style definition.
Definition: ff_other.h:18735
void SetUseShowClefs(bool state)
Sets if the clef should be part of the staff style or not.
Definition: ff_other.h:19061
bool GetUseShowTies() const
Returns true if the display of ties is active for the staff style definition.
Definition: ff_other.h:18808
void SetUseShowStaffLines(bool state)
Sets if staff line display should be part of the staff style or not.
Definition: finaleframework.cpp:12131
void SetUseAltNotationStyle(bool state)
Sets if the alternate notation style should be part of the staff style or not.
Definition: ff_other.h:19324
bool GetUseShowScoreStaffNames() const
Returns true if the statff name display in the score is active for the staff style definition.
Definition: ff_other.h:18786
void SetUseIgnoreKeySig(bool state)
Sets if the "Ignore Key Signature" state should be part of the staff style or not.
Definition: ff_other.h:19303
bool GetUseIndependentFont() const
Returns true if the independent notehead font state should be used for the staff style definition.
Definition: ff_other.h:18815
bool GetUseShowNoteShapes() const
Returns true if note shapes should be used for the staff style definition.
Definition: finaleframework.cpp:12110
bool GetUseBreakRepeatBarlines() const
Returns true if the "Break repeat barlines between staves" setting should be used for the staff style...
Definition: ff_other.h:18881
void SetAddToMenu(bool value)
Sets if the staff style definition should be added to the staff style menu, or not.
Definition: ff_other.h:19009
void SetUseShowBarlines(bool state)
Sets if the barline display setting should be part of the staff style or not.
Definition: ff_other.h:19261
bool GetUseAllowHiding() const
Returns true if the "optimization" state should be used for the staff style definition.
Definition: ff_other.h:18843
bool GetUseShowTimeSignatures() const
Returns true if the time signature setting is active for the staff style definition.
Definition: ff_other.h:18715
bool GetUseAbbreviatedPosition() const
Returns true if the abbreviated name positioning should be used for the staff style definition.
Definition: ff_other.h:18951
bool GetUseShowTextRepeats() const
Returns true if the text repeat display setting should be used for the staff style definition.
Definition: ff_other.h:18888
bool GetUseAbbreviatedName() const
Returns true if the abbreviated staff name should be used for the staff style definition.
Definition: ff_other.h:18909
void SetUseAbbreviatedPosition(bool state)
Sets if the abbreviated name positioning should be part of the staff style or not.
Definition: ff_other.h:19317
void SetUseDefaultClef(bool state)
Sets if the default clef setting should be part of the staff style or not.
Definition: ff_other.h:19216
bool GetUseShowBarlines() const
Returns true if the barline display setting should be used for the staff style definition.
Definition: ff_other.h:18895
bool GetUseBreakBarlines() const
Returns true if the "Break barlines between staves" setting should be used for the staff style defini...
Definition: ff_other.h:18874
void SetUseNoKeySigShowAccidentals(bool state)
Sets if "Hide key signature & show all accidentals" (available in the Finale 2014 Score Manager) shou...
Definition: finaleframework.cpp:12145
void SetUseShowScoreStaffNames(bool state)
Sets if staff name display in score should be part of the staff style or not.
Definition: ff_other.h:19140
bool GetUseFullNamePosition() const
Returns true if the full name positioning should be used for the staff style definition.
Definition: ff_other.h:18944
bool GetUseShowAugmentationDots() const
Returns true if the augmentation dot setting is active for the staff style definition.
Definition: ff_other.h:18742
bool GetUseShowClefs() const
Returns true if the clef is active for the staff style definition.
Definition: ff_other.h:18728
bool GetUseShowKeySignatures() const
Returns true if the "Display Key Signature" is active for the staff style definition.
Definition: ff_other.h:18700
void SetUseIndependentFont(bool state)
Sets if independent notehead font state should be part of the staff style or not.
Definition: ff_other.h:19181
bool GetUseShowLyrics() const
Returns true if the lyrics display is active for the staff style definition.
Definition: ff_other.h:18756
bool GetUseIgnoreKeySig() const
Returns true if the "Ignore Key Signature" state should be used for the staff style definition.
Definition: ff_other.h:18937
void SetUseShowPartTimeSignatures(bool state)
Sets if the parts time signature setting is active for the staff style definition.
Definition: ff_other.h:19051
void SetUseFlatBeams(bool state)
Sets if the flat beams state should be part of the staff style or not.
Definition: ff_other.h:19188
FCStaffStyleDef()
The constructor.
Definition: ff_other.h:18655
void SetUseTransposition(bool state)
Sets if the transposition settings should be part of the staff style or not.
Definition: ff_other.h:19233
void SetUseShowTimeSignatures(bool state)
Sets if time signature should be part of the staff style or not.
Definition: ff_other.h:19042
FCStaffNamePosition * GetFullNamePosition() override
Override of __FCStaffBase::GetFullNamePosition.
Definition: ff_other.h:19382
FCStaffNamePosition * GetAbbreviatedNamePosition() override
Override of __FCStaffBase::GetAbbreviatedNamePosition.
Definition: ff_other.h:19397
bool GetUseShowStaffLines() const
Returns true if the display of staff lines is active for the staff style definition.
Definition: finaleframework.cpp:12103
bool IsInstrumentChange()
Returns true if the staff style is a 2012 instrument change.
Definition: finaleframework.cpp:12050
bool GetUseShowPartTimeSignatures() const
Returns true if the parts time signature setting is active for the staff style definition.
Definition: ff_other.h:18721
void SetUseStafflineAdjustments(bool state)
Sets if the staffline adjustments settings should be part of the staff style or not.
Definition: ff_other.h:19226
bool GetAddToMenu() const
Returns if the staff style definition should be added to the staff style menu, or not.
Definition: ff_other.h:18688
void SetUseFullNamePosition(bool state)
Sets if the full name positioning should be part of the staff style or not.
Definition: ff_other.h:19310
bool GetUseRedisplayOtherLayerAccidentals() const
Returns true if "Redisplay accidentals in other layers within measures" should be used for the staff ...
Definition: finaleframework.cpp:12124
The class for a staff system on a page.
Definition: ff_other.h:3715
void SetResize(twobyte value)
Sets the staff system's resize value (in percent).
Definition: ff_other.h:3866
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:3740
eMeas GetNextSysMeasure() const
Returns the starting measure number for the next system.
Definition: ff_other.h:3930
eMeas GetFirstMeasure() const
Returns the measure for the first measure of the system.
Definition: ff_other.h:3923
eStaff CalcTopStaff()
Calculates the top staff ID for the staff system.
Definition: finaleframework.cpp:5054
Evpu16 GetRightMargin() const
Returns the right margin value, in EVPUs.
Definition: ff_other.h:3987
void SetUseStaffResize(bool state)
Sets the flag that marks if any of the staves on the system use individual staff resizing.
Definition: ff_other.h:3903
int CalcHeight(bool verticalresize)
Calculates the height of the staff system.
Definition: finaleframework.cpp:5083
twobyte GetSpaceAfterMusic() const
Gets the extra space after the music, in EVPUs.
Definition: ff_other.h:3945
twobyte GetStaffHeight() const
Returns the default staff height for the system, in 1/64th of a Evpu32.
Definition: ff_other.h:3998
void SetRightMargin(Evpu16 margin)
Sets the right system margin value, in EVPUs. This is usually a negative value, since it's the distan...
Definition: ff_other.h:3859
twobyte GetResize() const
Returns the resize value (in percent) for the system.
Definition: ff_other.h:4005
FCSystemStaves * CreateSystemStaves()
Creates a staff list with the staves available for the system.
Definition: finaleframework.cpp:4975
twobyte GetSpaceAbove() const
Returns the space to the previous system (or the distance from the top page margin),...
Definition: ff_other.h:3954
void SetLeftMargin(Evpu16 margin)
Sets the left margin value, in EVPUs.
Definition: ff_other.h:3850
Int100 GetHorizontalStretch() const
Returns the calculated horizontal stretch of the system contents, in 1/100 of a percent.
Definition: ff_other.h:4052
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:3741
bool ContainsMeasure(eMeas measurenumber)
Returns true if the measure number is on the system.
Definition: ff_other.h:4127
bool GetHoldMargins() const
Returns the "Hold Margins" flag for the staff system.
Definition: ff_other.h:4032
void SetBottomMargin(Evpu16 margin)
Sets the bottom margin value, referenced from the staff baseline of the bottom staff,...
Definition: ff_other.h:3840
bool IsOptimized() const
Returns true if the system is "optimized".
Definition: finaleframework.cpp:4967
void SetSpaceAfterMusic(twobyte space)
Sets the extra space after the music, in EVPUs.
Definition: ff_other.h:3808
void SetNextSysMeasure(eMeas measure)
Sets the measure starting the next system.
Definition: ff_other.h:3792
bool HasPageBreak()
Returns true if the first measure of the staff system has a page break (or "start a new page" marker)...
Definition: finaleframework.cpp:4960
twobyte GetTopStaff() const
Returns the staff number of the top staff of the system.
Definition: finaleframework.cpp:4982
bool GetResizeVerticalSpace() const
Returns true if the "Resize Vertical Space" option is set.
Definition: ff_other.h:4013
void SetSpaceAbove(twobyte space)
Sets the space to the previous system, in EVPUs.
Definition: ff_other.h:3816
eStaff CalcBottomStaff()
Calculates the bottom staff ID for the staff system.
Definition: finaleframework.cpp:5062
int CalcWhiteSpaceBottom(bool verticalresize)
Calculates the vertical white space below the first staff line to the bottom system margin.
Definition: finaleframework.cpp:5101
void SetSpaceBeforeMusic(twobyte space)
Sets the extra space before the music, in EVPUs.
Definition: ff_other.h:3800
twobyte GetSpaceBeforeMusic() const
Gets the extra space before the music, in EVPUs.
Definition: ff_other.h:3937
void SetHoldMargins(bool state)
Sets the flag for "Hold Margins" for the staff system.
Definition: ff_other.h:3912
void SetResizeVerticalSpace(bool value)
Sets the "Resize Vertical Space" option.
Definition: ff_other.h:3891
Evpu16 GetBottomMargin() const
Returns the bottom margin value, in EVPUs.
Definition: ff_other.h:3969
void SetStaffHeight(twobyte value)
Sets the default staff height for the system, in 1/64th of a Evpu32.
Definition: ff_other.h:3883
bool GetUseStaffResize() const
Returns the flag that marks if any of the staves on the system use individual staff resizing.
Definition: ff_other.h:4023
void SetTopMargin(Evpu16 margin)
Sets the top margin value (the distance between the system top and the topmost staff reference line),...
Definition: ff_other.h:3827
FCFreezeSystem * CreateFreezeSystem(bool force_create=true)
Creates a corresponding FCFreezeSystem object, if any such exists.
Definition: finaleframework.cpp:5021
int CalcStavesSpan()
Calculates the distance from the reference line of the top-most staff to the reference of the bottom-...
Definition: finaleframework.cpp:5070
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:4191
Evpu16 GetTopMargin() const
Returns the top margin value, in EVPUs.
Definition: ff_other.h:3962
void SetFirstMeasure(eMeas measure)
Sets the first measure to start the system.
Definition: ff_other.h:3781
bool CalcRegion(FCMusicRegion *pRegion)
Get the region for the staff system.
Definition: finaleframework.cpp:4989
Evpu16 GetLeftMargin() const
Returns the left margin value, in EVPUs.
Definition: ff_other.h:3979
FCStaffSystem()
The constructor.
Definition: ff_other.h:3757
Class that provides storage for text. This is to achieve platform-transparent text handling,...
Definition: ff_base.h:1877
void AppendCharacter(eUniChar32 character)
Appends a character to the string.
Definition: finaleframework.cpp:1825
eUniChar16 GetCharacterAt(int index) const
Returns the character at the index position.
Definition: finaleframework.cpp:2008
int GetLength() const
Returns the length of the string.
Definition: ff_base.h:3024
bool CopyToUnicodeBuffer(eUniChar16 *pBuffer, int maxbufferlen=0) const
Copies the string to a 16-bit Unicode buffer. The buffer must be big enough to have room for an endin...
Definition: finaleframework.cpp:1297
void SetCString(const char *pszBuffer, int maxchars=-1)
Sets the string, using a C-string version of the string.
Definition: finaleframework.cpp:1234
void AppendFloat(double value)
Appends an floating-point value to the string.
Definition: finaleframework.cpp:1884
const char * GetCString() const
Returns a C-string version of the string.
Definition: finaleframework.cpp:1338
void SetString(const FCString *pString)
Copies a string.
Definition: finaleframework.cpp:2398
bool TruncateAt(int newlength)
Truncates the string at the indicated position.
Definition: ff_base.h:3639
int FormatCString(const char *fmt,...)
Formats a string using the same syntax and manner as the printf() function in C. The version of the m...
Definition: finaleframework.cpp:1088
void Clear()
Creates an empty string.
Definition: ff_base.h:2383
void AppendCString(const char *pOtherString)
Appends a C-style string to the string.
Definition: finaleframework.cpp:1861
bool IsEmpty() const
Returns true if the string is empty.
Definition: ff_base.h:3148
bool TrimEnigmaFontTags()
Removes all Enigma font tags from a string, leaving only the actual text and text insert tags,...
Definition: finaleframework.cpp:1437
bool IsEqualString(const FCString &value) const
Returns true if the string is identical with the parameter. (FCString string version....
Definition: ff_base.h:3111
void SetUnicodeString(const eUniChar16 *pChar, int maxchars=-1)
Sets the string by using a 16-bit Unicode buffer as input parameter.
Definition: finaleframework.cpp:1273
void AppendInteger(int value)
Appends an integer value (decimal) to the string.
Definition: finaleframework.cpp:1877
Collection class for FCString class objects.
Definition: ff_basecollection.h:1085
Class that stores one "inci" of a staff list (for a system or for the global list of staves).
Definition: ff_other.h:6952
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:6982
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:7090
FCSystemStaff()
The constructor.
Definition: ff_other.h:6999
bool SaveNew(CMPER itemno) override
Overridden version of SaveNew (to save the resize of the staff as well)
Definition: finaleframework.cpp:7759
void SetStaff(eStaff staffno)
Sets the 1-based staff number for this slot.
Definition: ff_other.h:7030
void SetDistance(Evpu32 distance)
Sets the distance between this staff and the top staff.
Definition: ff_other.h:7024
int GetResize() const
Returns the resize for the specific staff, in percent.
Definition: ff_other.h:7053
bool DeleteResizeData()
Deletes the staff resize data connected with the system/staff.
Definition: ff_other.h:7078
bool Load(CMPER itemno, twobyte inci) override
Overridden version of Load (to get the resize of the staff as well)
Definition: finaleframework.cpp:7738
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:6981
void SetResize(int value)
Sets the resize for the specific staff, in percent. Setting the value to 100 will clear any resize da...
Definition: ff_other.h:7067
eStaff GetStaff() const override
Returns the 1-based staff number for this slot.
Definition: ff_other.h:7046
bool Save() override
Overridden version of Save (to save the resize of the staff as well)
Definition: finaleframework.cpp:7784
Evpu32 GetDistance() const
Returns the distance between this staff and the top staff.
Definition: ff_other.h:7039
Collection class for FCSystemStaff class objects, which contains the list of staves available within ...
Definition: ff_othercollection.h:544
The class for a single tempo change in the Tempo Tool. The tempo elements should be stored in measure...
Definition: ff_other.h:23987
FCTempoElement()
The constructor.
Definition: ff_other.h:24032
bool GetAbsolute() const
Returns true if the tempo is an absolute or relative tempo setting.
Definition: ff_other.h:24057
void SetRatio(fourbyte value)
Sets the tempo ratio value.
Definition: ff_other.h:24081
float CalcValue()
Returns the actual value for the tempo. The returned value might be absolute or relative,...
Definition: ff_other.h:24092
void SetAbsoluteValue(float value)
Sets the tempo to an actual absolute value.
Definition: ff_other.h:24122
void SetMeasurePos(twobyte edupos)
Sets the duration reference position for the element.
Definition: ff_other.h:24044
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:24015
TimeEdu32 GetMeasurePos() const override
Gets the duration reference position for the element.
Definition: ff_other.h:24050
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:24016
fourbyte GetRatio() const
Returns the tempo ratio value.
Definition: ff_other.h:24075
void SetAbsolute(bool value)
Sets the tempo to absolute or relative.
Definition: ff_other.h:24065
void SetRelativeValue(float value)
Sets the tempo to an actual relative value in percent.
Definition: ff_other.h:24139
Collection class for FCTempoElements class objects for one measure. The tempo elements should be stor...
Definition: ff_othercollection.h:1718
Class for a text block.
Definition: ff_other.h:16048
void SetRoundedCornerRadius(Efix32 radius)
Sets the rounded corner radius, to use when rounded corners are enabled for the text block frame.
Definition: ff_other.h:16491
void SetLineSpacing(twobyte linespacing)
Sets the line spacing value for the text block.
Definition: ff_other.h:16334
twobyte GetRawTextID() const
Returns the text ID for the raw text.
Definition: ff_other.h:16226
void SetVerticalTextOffset(int value)
Sets the vertical offset for the text (relative to the left frame side).
Definition: ff_other.h:16529
int GetVerticalTextOffset() const
Returns the vertical offset for the text (relative to the left frame side).
Definition: ff_other.h:16601
bool GetShowBorders() const
Returns if the borders should display for the txt block, or not.
Definition: ff_other.h:16610
bool SaveNewRawTextString(FCString *pString)
Saves a new raw text string.
Definition: finaleframework.cpp:9391
void SetLineInset(int value)
Sets the inset between text and border (in EFIXes) for the frame's border.
Definition: ff_other.h:16510
void _SetRawTextID(twobyte therawtextid)
Sets the text ID for the raw text.
Definition: ff_other.h:16231
void SetRoundedCorners(bool state)
Sets if the text frame should use rounded corners.
Definition: ff_other.h:16477
bool SaveRawTextString(FCString *pString)
Saves the raw text string in an existing text block.
Definition: finaleframework.cpp:9382
EXTAG GetRawTextExtag()
Returns the full EXTAG that is used to store the raw text.
Definition: ff_other.h:16234
bool GetRoundedCorners() const
Returns if the text frame should use rounded corners.
Definition: ff_other.h:16400
bool GetExpandSingleWord() const
Returns the "expand single word" state, which effects the full justification modes.
Definition: ff_other.h:16387
bool DeepDeleteData() override
Reimplementation to delete raw text as well.
Definition: ff_other.h:16314
bool GetLineSpacingIsPercent() const
Returns if the line spacing value should be percent or points.
Definition: ff_other.h:16366
bool GetExpandVertically() const
Returns if the text block is set to "Expand Vertically" for a standard frame.
Definition: ff_other.h:16659
FCString * CreateRawTextString()
Creates a string object for the connected raw text.
Definition: finaleframework.cpp:9374
void SetWordWrap(bool state)
Sets if the text should word wrap automatically.
Definition: ff_other.h:16454
Evpu16 GetWidth() const
Returns the fixed width of the frame.
Definition: ff_other.h:16623
bool GetExpandHorizontally() const
Returns if the text block is set to "Expand Vertically" for a standard frame.
Definition: ff_other.h:16647
TEXTBLOCKJUSTIFY
Constants for text justification.
Definition: ff_other.h:16184
void SetJustification(FLAG_16 justification)
Sets the justification to any of the text block justification styles.
Definition: ff_other.h:16306
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:16193
void SetWidth(Evpu16 width)
Sets the fixed width of the frame.
Definition: ff_other.h:16551
FCTextBlock()
The constructor.
Definition: ff_other.h:16207
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:16194
bool GetFrameReference() const
Returns if the text block should be positioned by the frame layout or not. This is a compatibility bi...
Definition: ff_other.h:16355
FLAG_16 GetJustification() const
Returns the justification for the text block.
Definition: ff_other.h:16343
Evpu16 GetHeight() const
Returns the fixed height of the frame.
Definition: ff_other.h:16636
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:16665
twobyte GetLineSpacing() const
Returns the line spacing value for the text block.
Definition: ff_other.h:16327
void SetFrameReference(bool state)
Sets if the text block should be positioned by the frame layout or not.
Definition: ff_other.h:16432
int GetLineWidth() const
Returns the line width of the frame's border.
Definition: ff_other.h:16574
void SetHeight(Evpu16 height)
Sets the fixed height of the frame.
Definition: ff_other.h:16564
void SetLineWidth(int value)
Sets the line width (in EFIXes) of the frame's border.
Definition: ff_other.h:16500
int GetLineInset() const
Returns the inset between text and border (in EFIXes) for the frame's border.
Definition: ff_other.h:16583
void SetExpandSingleWord(bool state)
Sets the "expand single word" state, which effects the full justification modes.
Definition: ff_other.h:16464
void SetLineSpacingIsPercent(bool state)
Sets if the line spacing value should be percent or points.
Definition: ff_other.h:16443
Efix32 GetRoundedCornerRadius() const
Returns the rounded corner radius, to use when rounded corners are enabled for the text block frame.
Definition: ff_other.h:16415
int GetHorizontalTextOffset() const
Returns the horizontal offset for the text (relative to the left frame side).
Definition: ff_other.h:16592
twobyte GetShapeID() const
Return the layout shape ID for the text block.
Definition: ff_other.h:16248
void SetHorizontalTextOffset(int value)
Sets the horizontal offset for the text (relative to the left frame side).
Definition: ff_other.h:16520
void SetRawText(twobyte theid, ETAG tag=LO_UTWOBYTE(tx_TextBlock))
Sets the raw text ID and tag for the raw text. This can be used prior to SaveNewRawTextString to set ...
Definition: ff_other.h:16294
void SetShapeID(twobyte shapeID)
Sets the layout shape ID for the text block.
Definition: ff_other.h:16290
void SetShowBorders(bool state)
Sets if the borders should display for the txt block, or not.
Definition: ff_other.h:16538
bool GetWordWrap() const
Returns true if the text should word wrap automatically.
Definition: ff_other.h:16377
Class for a text expression definition.
Definition: ff_other.h:14515
bool GetHideMeasureNumbers() const
Returns true if the rehearsal mark text expression hides the measure numbers.
Definition: ff_other.h:14769
bool IsPlaybackTempo() const
Returns true if the expression is defined for tempo playback.
Definition: ff_other.h:15332
void SetHorizontalAlignmentPoint(FCCategoryDef::HORIZ_ALIGNMENT value)
Sets the "Horizontal Alignment Point" setting in the text expression definition.
Definition: ff_other.h:15260
twobyte GetPlaybackPass() const
Definition: ff_other.h:14862
FCString * CreateDescription()
Creates a string object that contains the description text.
Definition: finaleframework.cpp:10702
void SetDescription(FCString *pDescriptionString)
Sets the description text for the text expression definition.
Definition: finaleframework.cpp:10609
twobyte GetVerticalEntryOffset() const
Returns the vertical "Additional Entry Offset" in the text expression definition.
Definition: ff_other.h:14936
bool IsSmartMusicMarker() const
Returns true if the text expression's playback style is defined as a SmartMusic marker....
Definition: ff_other.h:15343
void SetUseCategoryPos(bool value)
Sets if the "use category positioning" checkbox should be checked or not.
Definition: finaleframework.cpp:10584
twobyte GetHorizontalOffset() const
Returns the "Additional Horizontal Offset" value in the text expression definition.
Definition: ff_other.h:15281
bool DeleteTextBlock()
Removes the expression's text block (including its raw text data block) from Finale's database.
Definition: finaleframework.cpp:10523
void SetBreakMMRest(bool state)
Sets the "Break Multi-measure rest" option in the text expression definition.
Definition: ff_other.h:14997
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:14646
void SetPlaybackPass(twobyte value)
Sets the specific (1-based) pass number when the expression should play back.
Definition: ff_other.h:14873
twobyte GetVerticalBaselineOffset() const
Returns the vertical "Additional Baseline Offset" in the text expression definition.
Definition: ff_other.h:14922
bool GetUseCategoryPos() const
Returns true if the expression is marked to use the category positioning.
Definition: finaleframework.cpp:10663
twobyte GetCategoryID() const
Returns the category ID for the expression definition.
Definition: ff_other.h:14813
bool SaveNewTextBlock(FCString *pString)
Saves a new raw text block (both a raw text and the connected text block) and assigns it to the expre...
Definition: finaleframework.cpp:10508
twobyte GetPlaybackTempoDuration()
For tempo expressions, returns the metronome duration (in EDUs) for the defined playback tempo.
Definition: ff_other.h:14849
void SetUseCategoryFont(bool value)
Sets if the "use category font" should be checked or not.
Definition: finaleframework.cpp:10559
FCCategoryDef::VERT_ALIGNMENT GetVerticalAlignmentPoint() const
Returns the vertical alignment point for the expression definition positioning.
Definition: ff_other.h:14912
FCString * CreateTextString()
Gets a pointer to the text expression string, as a string object. If the string is empty,...
Definition: finaleframework.cpp:10444
FCCategoryDef::HORIZ_ALIGNMENT GetHorizontalAlignmentPoint() const
Returns the "Horizontal Alignment Point" setting in the text expression definition.
Definition: ff_other.h:15246
bool GetUseExecutableShape() const
Returns true if an executable is used for the expression def.
Definition: ff_other.h:14725
twobyte GetPlaybackTempoValue()
For tempo expressions, returns the playback tempo value.
Definition: ff_other.h:14835
twobyte GetPlaybackKeyVelocity() const
Returns the key velocity value (if the playback type is key velocity).
Definition: ff_other.h:14882
void SetPlaybackType(EXPR_PLAYBACK_TYPES playbackmode)
Sets the playback type for the expression def.
Definition: finaleframework.cpp:10757
twobyte GetPlaybackControllerNumber() const
returns the playback MIDI controller number.
Definition: ff_other.h:15064
REHEARSALMARK_STYLES GetRehearsalMarkStyle() const
Returns the rehearsal mark numbering style.
Definition: ff_other.h:14958
bool DeepDeleteData() override
Reimplemented version of DeepDeleteData() for FCTextExpressionDef objects.
Definition: finaleframework.cpp:10326
void SetHorizontalOffset(twobyte value)
Sets the "Additional Horizontal Offset" in the text expression definition.
Definition: ff_other.h:15291
CMPER GetTextBlockID()
Returns the text block ID (for use with FCTextBlock).
void SetVerticalEntryOffset(twobyte value)
Sets the vertical "Additional Entry Offset" in the text expression definition.
Definition: ff_other.h:15184
twobyte GetTextID() const
Returns the text ID for the expression text. For use with the FCTextBlock class.
Definition: ff_other.h:14827
bool MakeRehearsalMark(FCString *pString, int measure)
Creates an automatic rehearsal string based on the definition and a measure.
Definition: finaleframework.cpp:10466
void SetExecutableShapeID(twobyte shapeID)
Sets the executable shape ID for the expression def.
Definition: ff_other.h:14749
bool AssignToCategory(FCCategoryDef *pDef)
Assigns the expression definition to a category.
Definition: finaleframework.cpp:10539
void SetPlaybackTempo(TimeEdu32 eduduration, int tempo)
Sets the playback tempo type for the expression definition.
Definition: ff_other.h:15088
bool IsKeyVelocity() const
Returns true if the text expression's playback style is defined as key velocity.
Definition: ff_other.h:15351
bool SaveTextString(FCString *pString)
Resaves the text for an existing text expression.
Definition: finaleframework.cpp:10497
REHEARSALMARK_STYLES
The rehearsal number mark types available to text expressions.
Definition: ff_other.h:14557
@ REHMARKSTYLE_MEASNUM
Definition: ff_other.h:14577
@ REHMARKSTYLE_LETNUM_LC
Definition: ff_other.h:14571
@ REHMARKSTYLE_LETTER
Definition: ff_other.h:14562
@ REHMARKSTYLE_NUMBER
Definition: ff_other.h:14574
@ REHMARKSTYLE_LETNUM
Definition: ff_other.h:14565
@ REHMARKSTYLE_MANUAL
Definition: ff_other.h:14559
@ REHMARKSTYLE_LETTER_LC
Definition: ff_other.h:14568
twobyte GetExecutableShapeID() const
Returns the executable shape ID.
Definition: ff_other.h:14736
twobyte GetPlaybackControllerValue() const
returns the playback controller value.
Definition: ff_other.h:15051
void SetHorizontalJustification(FCCategoryDef::HORIZ_JUSTIFICATION value)
Sets the "Horizontal Justification" in the text expression definition.
Definition: ff_other.h:15221
void SetVerticalBaselineOffset(twobyte value)
Sets the vertical "Additional Baseline Offset" in the text expression definition.
Definition: ff_other.h:15170
void SetPlaybackController(twobyte controllernumber, twobyte value)
Sets the playback to a specific MIDI CC controller.
Definition: ff_other.h:15075
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:15464
FCCategoryDef::HORIZ_JUSTIFICATION GetHorizontalJustification() const
Returns the "Horizontal Justification" setting in the text expression definition.
Definition: ff_other.h:15205
EXPR_PLAYBACK_TYPES GetPlaybackType() const
Returns the playback type for the expression def.
Definition: finaleframework.cpp:10714
bool IsAutoRehearsalMark() const
Returns true if an automatic rehearsal number style is used.
Definition: ff_other.h:15361
FCEnclosure * CreateEnclosure()
Loads and creates an enclosure object. It's the caller's responsibility to free the allocated memory ...
Definition: finaleframework.cpp:10454
void SetPlaybackKeyVelocity(twobyte value)
Sets the playback mode to key velocity and changes the key velocity value.
Definition: ff_other.h:14894
bool GetBreakMMRest() const
Returns the "Break Multi-measure rest" option in the text expression definition.
Definition: ff_other.h:14987
virtual ~FCTextExpressionDef()
The destructor.
Definition: finaleframework.cpp:10354
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:14645
void SetPlaybackTransposition(twobyte halfsteps)
Sets the playback transposition type for the expression definition.
Definition: ff_other.h:15116
void SetHideMeasureNumbers(bool value)
Sets if the rehearsal mark text expression hides the measure numbers or not.
Definition: ff_other.h:14778
EXPR_PLAYBACK_TYPES
Return values for the GetPlaybackType method.
Definition: ff_other.h:14589
@ EXPPLAYTYPE_PERCUSSIONMAP
Definition: ff_other.h:14630
@ EXPPLAYTYPE_MIDICHANNEL
Definition: ff_other.h:14609
@ EXPPLAYTYPE_IGNORETEMPOTOOL
Definition: ff_other.h:14618
@ EXPPLAYTYPE_NONE
Definition: ff_other.h:14642
@ EXPPLAYTYPE_MIDIDUMP
Definition: ff_other.h:14606
@ EXPPLAYTYPE_TRANSPOSE
Definition: ff_other.h:14603
@ EXPPLAYTYPE_PLAYTEMPOTOOL
Definition: ff_other.h:14615
@ EXPPLAYTYPE_CONTROLLER
Definition: ff_other.h:14600
@ EXPPLAYTYPE_PATCHCHANGE
Definition: ff_other.h:14621
@ EXPPLAYTYPE_UNKNOWN
Definition: ff_other.h:14591
@ EXPPLAYTYPE_KEYVELOCITY
Definition: ff_other.h:14594
@ EXPPLAYTYPE_SWING
Definition: ff_other.h:14633
@ EXPPLAYTYPE_HUMANPLAYBACKON
Definition: ff_other.h:14636
@ EXPPLAYTYPE_PITCHWHEEL
Definition: ff_other.h:14627
@ EXPPLAYTYPE_CHANNELPRESSURE
Definition: ff_other.h:14624
@ EXPPLAYTYPE_RESTRIKEKEYS
Definition: ff_other.h:14612
@ EXPPLAYTYPE_TEMPO
Definition: ff_other.h:14597
@ EXPPLAYTYPE_HUMANPLAYBACKOFF
Definition: ff_other.h:14639
void SetRehearsalMarkStyle(REHEARSALMARK_STYLES value)
Sets the rehearsal mark numbering style.
Definition: ff_other.h:14970
twobyte GetPitchWheelValue() const
Returns the pitchwheel value.
Definition: ff_other.h:15130
void SetVerticalAlignmentPoint(FCCategoryDef::VERT_ALIGNMENT value)
Sets the vertical alignment point for the expression definition positioning.
Definition: ff_other.h:15154
void SetPitchWheelValue(twobyte value)
Sets the playback MIDI pitchwheel type] for the expression definition.
Definition: ff_other.h:15143
twobyte GetPlaybackTransposition() const
Returns the playback transposition in half-steps.
Definition: ff_other.h:15103
void SetUseEnclosure(bool value)
Sets if the text expression uses an enclosure or not.
Definition: ff_other.h:14796
void GetDescription(FCString *pDescriptionString)
Gets the description text for the text expression definition.
Definition: finaleframework.cpp:10688
FCTextExpressionDef()
The constructor.
Definition: finaleframework.cpp:10309
bool GetUseEnclosure() const
Returns true if the text expression uses an enclosure.
Definition: ff_other.h:14787
bool GetUseCategoryFont() const
Returns true if the expression is marked to use the category font.
Definition: finaleframework.cpp:10638
void SetUseExecutableShape(bool state)
Sets the use of executable shape. Normally this isn't called directly. Instead, use SetExecutableShap...
Definition: ff_other.h:14760
bool DeepSaveAs(CMPER itemno) override
Reimplemented method that makes a copy of the text string before resaving.
Definition: ff_other.h:14662
void SetCategoryID(twobyte ID)
Sets the category ID for the expression definition.
Definition: ff_other.h:15008
The class for a text repeat definition.
Definition: ff_other.h:20797
REPEAT_REPLACE_MODE GetReplaceMode() const
Returns how '#' should be treated and replaced by the text repeat.
Definition: finaleframework.cpp:11051
FCEnclosure * CreateEnclosure()
Loads and returns a pointer to the loaded enclosure object for the text repeat.
Definition: finaleframework.cpp:10982
FCTextRepeatDef()
The constructor.
Definition: finaleframework.cpp:10848
bool DeepDeleteData() override
Reimplemented method that deletes the enclosure and text string before deleting the data.
Definition: ff_other.h:20921
REPEAT_REPLACE_MODE
Constants for use with FCTextRepeatDef::GetReplaceMode() and FCTextRepeatDef::SetReplaceMode().
Definition: ff_other.h:20877
@ REPEATREPLACE_TARGETMEASURE
Definition: ff_other.h:20885
@ REPEATREPLACE_TIMESPLAYED
Definition: ff_other.h:20879
@ REPEATREPLACE_TARGETTEXT
Definition: ff_other.h:20882
void SetReplaceMode(REPEAT_REPLACE_MODE value)
Sets how '#' should be treated and replaced by the text repeat.
Definition: finaleframework.cpp:11058
FCString * CreateTextString()
Gets a pointer to the text repeat string, as a string object.
Definition: finaleframework.cpp:10946
bool DeepSaveAs(CMPER itemno) override
Reimplemented method that makes a copy of the enclosure and text string before resaving.
Definition: finaleframework.cpp:10867
bool SaveTextString(FCString *pString)
Saves the text to the text repeat definition. The main FCTextRepeatDef data must be saved first.
Definition: finaleframework.cpp:10953
void SetFontInfo(FCFontInfo *pInfo)
Sets the font info for the text repeat.
Definition: ff_other.h:21021
bool DeepSaveNew(FCString *pString, FCEnclosure *pEnclosure)
Saves a new FCTextRepeatDef object, together with a text string and an (optional) enclosure....
Definition: finaleframework.cpp:10962
void SetUseThisFont(bool state)
Returns the "Use This Font" setting. Only active if the '#' should be replaced by the target text.
Definition: ff_other.h:21044
void SetJustification(TEXT_REPEAT_JUSTIFICATION value)
Sets the justification for the text repeat.
Definition: finaleframework.cpp:11024
void GetFontInfo(FCFontInfo *pInfo)
Gets the font info for the text repeat.
Definition: ff_other.h:21009
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:20890
bool SaveEnclosure(FCEnclosure *pEnclosure)
Saves the enclosure to the FCTextRepeatDef object.
Definition: finaleframework.cpp:10996
bool GetUseThisFont() const
Returns the "Use This Font" setting. Only active if the '#' should be replaced by the target text.
Definition: ff_other.h:21034
TEXT_REPEAT_JUSTIFICATION
Constants for use with FCTextRepeatDef::GetJustification() and FCTextRepeatDef::SetJustification().
Definition: ff_other.h:20858
@ TEXTREPJUST_FULL
Definition: ff_other.h:20869
@ TEXTREPJUST_CENTER
Definition: ff_other.h:20866
@ TEXTREPJUST_LEFT
Definition: ff_other.h:20860
@ TEXTREPJUST_RIGHT
Definition: ff_other.h:20863
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:20889
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:21105
TEXT_REPEAT_JUSTIFICATION GetJustification() const
Returns the justification for the text repeat.
Definition: finaleframework.cpp:11019
Class for text repeat assignments to a measure. The assignment is connected with a FCTextRepeatDef de...
Definition: ff_other.h:21128
void SetShowMode(REPSHOWMODES mode)
Sets where the text repeat should be shown.
Definition: finaleframework.cpp:11100
void SetAutoUpdateTarget(bool state)
Sets the "Auto-update target" setting.
Definition: ff_other.h:21374
void SetAction(REPACTIONS mode)
Sets the action type for the text repeat assignment. This controls what should happen when the text r...
Definition: finaleframework.cpp:11207
void SetResetOnRepeat(bool state)
Sets the "Reset on Repeat" setting.
Definition: ff_other.h:21507
void SetTarget(int value)
Sets the target measure or ID for the text repeat. This value is dependent on the GetTargetTrigger() ...
Definition: ff_other.h:21362
void SetStaffListID(twobyte list)
Sets the staff list ID to be used.
Definition: ff_other.h:21461
twobyte GetTotalPasses() const
Returns the number of passes for the text repeat assignment.
Definition: ff_other.h:21472
bool AssignTextRepeatDef(FCTextRepeatDef *pDef)
Assigns a saved text repeat definition to a text repeat.
Definition: finaleframework.cpp:11717
void SetVerticalPos(Evpu32 value)
Sets the vertical position (in EVPUs) from the top reference line of the measure.
Definition: ff_other.h:21348
FCTextRepeatDef * CreateTextRepeatDef()
Creates a text repeat definition object for the text repeat.
Definition: finaleframework.cpp:11725
REPSHOWMODES GetShowMode() const
Returns where the text repeat should be shown.
Definition: finaleframework.cpp:11092
FCSeparatePlacements * CreateSeparatePlacements()
Creates a FCSeparatePlacements collection and loads it with all matching independent positioning reco...
Definition: finaleframework.cpp:11736
void SetVisible(bool state)
Sets if the repeat is visible. ("Show" is checked in the context menu.)
Definition: ff_other.h:21416
REPTARGETTRIGGERS
The modes used by FCTextRepeat::GetTargetTrigger() and FCTextRepeat::SetTargetTrigger().
Definition: ff_other.h:21197
@ REPTARGET_NEXTENDING
Definition: ff_other.h:21220
@ REPTARGET_BACKWARDS
Definition: ff_other.h:21210
@ REPTARGET_UNDEFINED
Definition: ff_other.h:21200
@ REPTARGET_DEFID
Definition: ff_other.h:21203
@ REPTARGET_NEVERSKIPENDING
Definition: ff_other.h:21213
@ REPTARGET_MEASURENUM
Definition: ff_other.h:21206
@ REPTARGET_FORWARDS
Definition: ff_other.h:21217
void SetTargetTrigger(REPTARGETTRIGGERS mode)
Sets the target "trigger", which controls how the GetTarget() value will be interpreted.
Definition: finaleframework.cpp:11138
FCTextRepeat()
The constructor.
Definition: ff_other.h:21253
void SetHorizontalPos(Evpu32 value)
Sets the horizontal position (in EVPUs) from the measure's origin. The value is depending on the FCTe...
Definition: ff_other.h:21336
void DebugDump() override
Outputs the class data/information for debugging purposes.
Definition: ff_other.h:21576
REPSHOWMODES
Constants for use with FCTextRepeat::GetShowMode() and FCTextRepeat::SetShowMode().
Definition: ff_other.h:21175
@ REPSHOW_ALL
Definition: ff_other.h:21177
@ REPSHOW_TOPSTAFF
Definition: ff_other.h:21180
@ REPSHOW_STAFFLIST
Definition: ff_other.h:21183
bool GetVisible() const
Returns true if the repeat is visible. ("Show" is checked in the context menu.)
Definition: ff_other.h:21407
void SetID(twobyte id)
Use with care! Sets the definition ID for the text repeat.
Definition: ff_other.h:21322
bool GetJumpIfIgnore() const
Returns the "Jump if ignoring repeats" setting.
Definition: ff_other.h:21488
bool GetAutoUpdateTarget() const
Returns the "Auto-update target" setting.
Definition: ff_other.h:21368
void SetTotalPasses(twobyte totalpasses)
Sets the number of passes for the text repeat assignment.
Definition: ff_other.h:21478
bool GetIndividualPositioning() const
Returns if individual positioning on different staves should be allowed or not.
Definition: ff_other.h:21383
const char * ClassName() const override
Returns the name of the class, for diagnostic purposes. This method MUST be overwritten in each child...
Definition: ff_other.h:21155
Evpu16 GetHorizontalPos() const
Returns the horiozontal position (in EVPUs) from the measure's origin. The value is depending on the ...
Definition: ff_other.h:21329
void SetIndividualPositioning(bool state)
Sets if individual positioning on different staves should be allowed..
Definition: ff_other.h:21395
REPACTIONS
Definition: ff_other.h:21232
@ REPACTION_ALWAYSJUMP
Definition: ff_other.h:21237
@ REPACTION_PLAYSECTION
Definition: ff_other.h:21243
@ REPACTION_JUMPONPASS
Definition: ff_other.h:21240
@ REPACTION_NEVERJUMP
Definition: ff_other.h:21234
@ REPACTION_STOPONPASS
Definition: ff_other.h:21246
REPACTIONS GetAction() const
Returns the action type for the text repeat assignment. This controls what should happen when the tex...
Definition: finaleframework.cpp:11183
Evpu16 GetVerticalPos() const
Returns the vertical position (in EVPUs) from the top reference line of the measure.
Definition: ff_other.h:21342
REPTARGETTRIGGERS GetTargetTrigger() const
Returns the target "trigger", which controls how the GetTarget() value will be interpreted.
Definition: finaleframework.cpp:11131
twobyte GetID() const
Returns the definition ID for the text repeat.
Definition: ff_other.h:21311
void SetJumpIfIgnore(bool state)
Sets the "Jump if ignoring repeats" setting.
Definition: ff_other.h:21494
const PDKFRAMEWORK_CLASSID GetClassID() const override
Returns the internal class ID for the PDK Framework class. This is implemented mostly because Lua has...
Definition: ff_other.h:21156
int GetTarget() const
Returns the target measure or ID for the text repeat. This value is dependent on the GetTargetTrigger...
Definition: ff_other.h:21355
twobyte GetStaffListID() const
Returns the staff list ID to be used for the text repeat assignment.
Definition: ff_other.h:21455
bool GetResetOnRepeat() const
Returns the "Reset on Repeat" setting.
Definition: ff_other.h:21501
Class for time signatures. Instances of this class are auto-created when needed by FCMeasure:GetTimeS...
Definition: ff_timesig.h:27
void SetAbbreviate(bool state)
Sets if the time signature should be abbreviated (to cut and common time).
Definition: ff_timesig.h:95
void SetBeatDuration(twobyte value)
Sets the beat duration (in EDUs), or the composite bottom ID.
Definition: ff_timesig.h:76
void SetCompositeTop(bool value)
Sets the composite "mark" of the top part of the time signature.
Definition: ff_timesig.h:82
void SetBeats(twobyte value)
Sets the number of beats, or the composite top ID.
Definition: ff_timesig.h:63
void SetCompositeBottom(bool value)
Sets the composite "mark" of the bottom part of the time signature.
Definition: ff_timesig.h:85
Class for attaching an tuplet to an entry.
Definition: ff_entrydetails.h:2153